Skip to content

Commit 655bd15

Browse files
committed
Adorn top-level files with a '.rst' suffix
1 parent 42f2c9f commit 655bd15

19 files changed

+21
-19
lines changed

.github/workflows/lint.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,9 @@ jobs:
102102
sphinx-lint
103103
--enable line-too-long
104104
--max-line-length 85
105-
CHANGES
105+
AUTHORS.rst
106+
CHANGES.rst
107+
CODE_OF_CONDUCT.rst
106108
CONTRIBUTING.rst
107109
README.rst
108110
doc/
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ type-check:
4949

5050
.PHONY: doclinter
5151
doclinter:
52-
sphinx-lint --enable line-too-long --max-line-length 85 CHANGES *.rst doc/
52+
sphinx-lint --enable line-too-long --max-line-length 85 *.rst doc/
5353

5454
.PHONY: test
5555
test:

doc/authors.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@
66
Sphinx authors
77
==============
88

9-
.. include:: ../AUTHORS
9+
.. include:: ../AUTHORS.rst

doc/changes.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ Changelog
1919
\makeatother
2020

2121

22-
.. include:: ../CHANGES
22+
.. include:: ../CHANGES.rst

doc/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ def linkify_issues_in_changelog(app, docname, source):
212212
""" Linkify issue references like #123 in changelog to GitHub. """
213213

214214
if docname == 'changes':
215-
changelog_path = os.path.join(os.path.dirname(__file__), "../CHANGES")
215+
changelog_path = os.path.join(os.path.dirname(__file__), "../CHANGES.rst")
216216
# this path trickery is needed because this script can
217217
# be invoked with different working directories:
218218
# * running make in docs/
@@ -227,7 +227,7 @@ def linkify(match):
227227

228228
linkified_changelog = re.sub(r'(?:PR)?#([0-9]+)\b', linkify, changelog)
229229

230-
source[0] = source[0].replace('.. include:: ../CHANGES', linkified_changelog)
230+
source[0] = source[0].replace('.. include:: ../CHANGES.rst', linkified_changelog)
231231

232232

233233
def setup(app):

0 commit comments

Comments
 (0)