Documentation guidelines for internal links on the README #384
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
Thomsch
added
the
documentation
Codecov Report
@@ Coverage Diff @@
## develop #384 +/- ##
========================================
Coverage 46.60% 46.60%
========================================
Files 67 67
Lines 12751 12751
Branches 317 317
========================================
Hits 5942 5942
Misses 6784 6784
Partials 25 25 Continue to review full report at Codecov.
|
added 6 commits
April 20, 2020 18:07
bouthilx
approved these changes
May 4, 2020
Closed
Merged
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.
I updated the latest and stable channels in https://readthedocs.org/ to respectively build from the branch develop and master. When linking our Sphinx documentation to the README, we can encounter problems when making a release where the documentation pointing to latest is not updated to stable, sending visitors to 404 error pages.
This content of this PR defines how such links are to be used on the README and how to migrate them during a release to integrate them to the legacy release documentation.