Sphinx docs#27
Merged
Merged
Conversation
Closed
Closed
Closed
…e via RTD YML + add RTD docs build badge to README
sr-murthy
force-pushed
the
sphinx-docs
branch
2 times, most recently
from
d1bf6aa to
c44974d
Compare
saraduque
approved these changes
May 11, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
To do a local Sphinx build on this branch after checkout run the
makecommand from the project root:A static site will be built in the
docs/_buildsubfolder (which is Git-ignored), and the index page will bedocs/_build/html/index.html.The current site as it looks on the PR.
After merging the published site should be accessible from https://isaric-arc.readthedocs.io. The docs project name had to be set to
isaric-arcto avoid a conflict with an existing completely different RTD docs project namedarc.