[docs] Integrate sphinx-issues into the Sphinx config
#12616
Conversation
I have a feeling that request will be rejected as being out of the scope. The extension seems to be focused on the issue trackers. |
|
I feel the same. It would be more widely applicable if it could be changed to sphinx-links or similar, but I don't think that's possible. |
|
My pull request sloria/sphinx-issues#145 to support role |
|
Now it's ready for review. |
|
I'm not convinced that it's worth the extra dependency (granted it's tiny) to remove only a few lines of static Sphinx configuration, but I suppose standardization of the role names (and any new ones) could be a benefit? I'll note that Ultimately I'm neutral on the change. |
|
@ichard26 yes, standardization is key. Plus, it's one thing less to copy over through many projects for people who tend to maintain many and sync them periodically. It also exposes a few other roles for free. |
|
@shenxianpeng now that you removed the entire setting, could you also drop the extension from the |
|
@pradyunsg easy merge? |
docs/html/conf.py
Outdated
| ] | ||
|
|
||
| # General information about the project. | ||
| project = "pip" | ||
| copyright = "The pip developers" | ||
| issues_default_group_project = "pypa/pip" |
There was a problem hiding this comment.
Please move this in its own section with it's own "Options for sphinx_issues" header, so that it's consistent with the rest of the configuration for this project.
There was a problem hiding this comment.
FYI, trivial fragments aren't displayed anywhere, and their content is disregarded. The contribution guidelines state that they should be empty (but this isn't linted for some reason). This is a way to fool the checks, but it doesn't let one actually tell the end-users what's happened/changed.
I believe that once #12853 is in, it'll be possible to move this to one of packaging/contrib/misc if desired.
| @@ -0,0 +1 @@ | |||
| Integrate ``sphinx-issues`` into the Sphinx config. | |||
There was a problem hiding this comment.
By the way, if it's decided that this should go to a change log, it should probably link the integrated project with a hyperlink.
|
@pradyunsg easy merge? |
closes #12551
issueandpull, only leftpypibecause sphinx-issues not support rolepypinow, but I have created Add new role:pypi:sloria/sphinx-issues#145 to let it supportspulltoprin NEWS.rst to fix the errorNEWS.rst:3614: ERROR: Unknown interpreted text role "pull".