Fix Sphinx 3.0.x build #3577
Merged
Fix Sphinx 3.0.x build #3577
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
…ule to avoid Sphinx warnings: src/pyramid/request.py:docstring of pyramid.request.Request.response:1: WARNING: duplicate object description of pyramid.request.Request.response, other instance in api/request, use :noindex: for one of them src/pyramid/request.py:docstring of pyramid.request.Request.session:1: WARNING: duplicate object description of pyramid.request.Request.session, other instance in api/request, use :noindex: for one of them
Closed
|
Blocked by sphinx-doc/sphinx#7418 (comment) I do not want to replace all terms to the same word casing. 279 case-sensitive mismatches! |
|
I got a quick response from the Sphinx folks. I put the |
|
Sphinx 3.0.x struck in Deform today. See my comment for further discussion about resolving duplicate entries: Pylons/deform#397 (review) |
|
I'm good with these changes. |
stevepiercy
added a commit
to stevepiercy/pyramid
that referenced
this pull request
May 4, 2020
stevepiercy
added a commit
to stevepiercy/pyramid
that referenced
this pull request
May 4, 2020
Sort of. In Sphinx 3.0.x, lots of things blow up on this branch, so I pinned it to `Sphinx < 3.0.0`. I think it is not worth the effort to fix everything in this branch for the sake of Sphinx 3.0.x, given that Pyramid 2.0 will soon be released and we won't be doing further updates. Use links to cookiecutter instead of intersphinx.
digitalresistor
added a commit
that referenced
this pull request
May 7, 2020
digitalresistor
added a commit
that referenced
this pull request
May 7, 2020
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.
WIP
Regarding these two warnings:
If I follow the advice do this:
...then it does not have an index entry and cannot be linked to, like so:
https://docs.pylonsproject.org/projects/pyramid/en/latest/api/request.html#pyramid.request.Request.response
I see that further down the rendered page, another
responseandsessionappear, which are from therequestdocstrings.I went ahead and tried a "fix" in commit , but I want to make sure that this doesn't mess up anything.
Alternatively, we could move all that rst into the docstrings, but I assume y'all put it at the top of the .rst file for a good reason.