IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

[docs] fix changelog include (#12564)

Browse Source 
Use `include-read` instead of `source-read` for special content transform. 
In-particular, this fixes an issue that `docs/changes.rst` would not re-build, when `CHANGES.rst` was changed.
This commit is contained in:
Chris Sewell 2024-07-14 06:35:35 +02:00 committed by GitHub
parent 9e6276feda
commit cbf0b8e419
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 6 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CHANGES.rst
View File

@ -28,9 +28,9 @@ Features added
.. rst-class:: compact .. rst-class:: compact
* Add ``level`` option to :rst:dir:`rubric` directive. * #12506 Add ``level`` option to :rst:dir:`rubric` directive.
Patch by Chris Sewell. Patch by Chris Sewell.
* Add optional ``description`` argument to * #12549 Add optional ``description`` argument to
:meth:`~sphinx.application.Sphinx.add_config_value`. :meth:`~sphinx.application.Sphinx.add_config_value`.
Patch by Chris Sewell. Patch by Chris Sewell.
* #11165: Support the `officially recommended`_ ``.jinja`` suffix for template * #11165: Support the `officially recommended`_ ``.jinja`` suffix for template

16
doc/conf.py
View File

@ -258,25 +258,17 @@ def parse_event(env, sig, signode):
return name return name
def linkify_issues_in_changelog(app, docname, source): def linkify_issues_in_changelog(app, path, docname, source):
"""Linkify issue references like #123 in changelog to GitHub.""" """Linkify issue references like #123 in changelog to GitHub."""
if docname == 'changes': if docname == 'changes':
changelog_path = os.path.join(os.path.dirname(__file__), '../CHANGES.rst')
# this path trickery is needed because this script can
# be invoked with different working directories:
# * running make in docs/
# * running tox -e docs in the repo root dir
with open(changelog_path, encoding='utf-8') as f:
changelog = f.read()
def linkify(match): def linkify(match):
url = 'https://github.com/sphinx-doc/sphinx/issues/' + match[1] url = 'https://github.com/sphinx-doc/sphinx/issues/' + match[1]
return f'`{match[0]} <{url}>`_' return f'`{match[0]} <{url}>`_'
linkified_changelog = re.sub(r'(?:PR)?#([0-9]+)\b', linkify, changelog) linkified_changelog = re.sub(r'(?:PR)?#([0-9]+)\b', linkify, source[0])
source[0] = source[0].replace('.. include:: ../CHANGES.rst', linkified_changelog) source[0] = linkified_changelog
REDIRECT_TEMPLATE = """ REDIRECT_TEMPLATE = """
@ -325,7 +317,7 @@ def setup(app: Sphinx) -> None:
from sphinx.util.docfields import GroupedField from sphinx.util.docfields import GroupedField
app.connect('autodoc-process-docstring', cut_lines(4, what=['module'])) app.connect('autodoc-process-docstring', cut_lines(4, what=['module']))
app.connect('source-read', linkify_issues_in_changelog) app.connect('include-read', linkify_issues_in_changelog)
app.connect('build-finished', build_redirects) app.connect('build-finished', build_redirects)
fdesc = GroupedField('parameter', label='Parameters', names=['param'], can_collapse=True) fdesc = GroupedField('parameter', label='Parameters', names=['param'], can_collapse=True)
app.add_object_type( app.add_object_type(