Update documentation build instructions #3734
Merged
Conversation
This file contains 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
The sphinx/ subdirectory of documentation/ no longer exists.
mguaypaq
added
the
documentation
joshuacwnewton
approved these changes
Mar 14, 2022
There was a problem hiding this comment.
Oh. Huh. I forgot that this README.rst even exists?
I've been writing and maintaining https://github.com/spinalcordtoolbox/spinalcordtoolbox/wiki/Documentation instead.
IIRC the person who added this page had suggested that it was more discoverable to have in-line documentation than to have it on the Wiki. But, I can't tell if that's just lead this page to being more difficult to maintain. 😆
Approving this change, but... It may be worth considering wiping out this README.rst and replacing it with a suggestion to view the Documentation section of the internal wiki instead, just so that we have a single source of truth for our dev documentation. 🤔
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The
sphinx/subdirectory ofdocumentation/no longer exists.