Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

documentation: deploy docs website to readthedocs #4043

Merged
merged 4 commits into from
Mar 11, 2025
Merged

Conversation

superlopuh
Copy link
Member

This PR sets up readthedocs hosting for our mkdocs docs, meaning we get the best of both worlds:

  • docs for each version of xDSL from now on available in a drop-down menu on a platform we don't need to manage (and maybe even for each PR but I haven't tried that yet)
  • we control how the docs are generated and structured in MKDocs's API, which is more flexible and modern than the readthedocs default Sphinx

Check it out here:

https://xdsl.readthedocs.io/en/latest/

We definitely want to clean it up and make it nicer before making public announcements but it seems like a big step forwards.

@superlopuh superlopuh added the documentation Improvements or additions to documentation label Mar 11, 2025
@superlopuh superlopuh self-assigned this Mar 11, 2025
@superlopuh
Copy link
Member Author

One more thing is that we can still use gh pages for something else if we decide to host on readthedocs, not sure that the current jupyterlite page is what we want, but it can stay up a little bit longer while we decide.

Copy link

codecov bot commented Mar 11, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.23%. Comparing base (e209b0c) to head (c5572d6).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4043   +/-   ##
=======================================
  Coverage   90.23%   90.23%           
=======================================
  Files         458      458           
  Lines       58409    58409           
  Branches     5691     5691           
=======================================
  Hits        52707    52707           
  Misses       4320     4320           
  Partials     1382     1382           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Collaborator

@compor compor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Navigation could use some work, but that's a great start!

- asdf plugin add uv
- asdf install uv latest
- asdf global uv latest
- VENV_EXTRAS="--all-extras" VENV_DIR="$READTHEDOCS_VIRTUALENV_PATH" make venv
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had to look up https://docs.readthedocs.com/platform/stable/reference/environment-variables.html#envvar-READTHEDOCS_VIRTUALENV_PATH. Not sure if it's worth adding it as a comment in similar fashion to the existing comment above.

@superlopuh superlopuh merged commit 0c10196 into main Mar 11, 2025
17 checks passed
@superlopuh superlopuh deleted the sasha/docs/gh-pages branch March 11, 2025 21:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants