Upgrade to latest Sphinx 5.1.1 and fix the top Edit on Github link #4174
Conversation
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
nickva
force-pushed
the
try-to-fix-docs-edit-link
branch
7 times, most recently
from
72bb766 to
9eaabe0
Compare
nickva
changed the title
nickva
force-pushed
the
try-to-fix-docs-edit-link
branch
4 times, most recently
from
aa128cc to
9235c30
Compare
Contributor
Author
|
The rendered example of this PR is at https://docs.couchdb.org/en/try-to-fix-docs-edit-link/ |
nickva
force-pushed
the
try-to-fix-docs-edit-link
branch
from
9235c30 to
bafd420
Compare
Contributor
Author
good idea, @big-r81, I'll give that a try |
"Edit on Github" link wasn't working and pointing to a non-existent "index" file. This was most likely because we override the index.html template, so the source renderer doesn't know what to link it to. Instead opt to make the top level "Edit on Github" point the docs readme page. Individual doc pages will point to their respective source pages. In addition, we were quite a bit behind on on the sphinx version 1.5 vs 5.1.1 this has caused quite a bit of headaches over the years as we had to pin jinja2, docutils and other libraries versions to avoid breaking things. The main issue after the upgrade was that the http domain became a bit more strict. After vendoring it in, we had to make a few multipart http examples use plaintext. On the positive side, it found broken references in the admin guide, so those were fixed. Since we're using the latest 5.1.1 opt to just use a python3 venv with a short setup.sh script. That should make it easier for contributors to build docs locally.
nickva
force-pushed
the
try-to-fix-docs-edit-link
branch
from
bafd420 to
c0c9829
Compare
Contributor
Author
|
@big-r81 great suggestion! httpcontrib now comes from pip (Also updated https://docs.couchdb.org/en/try-to-fix-docs-edit-link/) |
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.
"Edit on Github" link wasn't working and pointing to a non-existent "index" file. This was most likely because we override the index.html template, so the source renderer doesn't know what to link it to. Instead opt to make the top level "Edit on Github" point the docs readme page. Individual doc pages will point to their respective source pages.
In addition, we were quite a bit behind on on the sphinx version 1.5 vs 5.1.1 this has caused quite a bit of headaches over the years as we had to pin jinja2, docutils and other libraries versions to avoid breaking things.
The main issue after the upgrade was that the http domain became a bit more strict. After vendoring it in, we had to make a few multipart http examples use plaintext. On the positive side, it found broken references in the admin guide, so those were fixed. Since we're using the latest 5.1.1 opt to just use a python3 venv with a short setup.sh script. That should make it easier for contributors to build docs locally.