Add support for linking to issues and adding datestamps to changelog entries.
This commit is contained in:
parent
58f71d1e2b
commit
01e953bac9
20
docs/conf.py
20
docs/conf.py
|
@ -5,6 +5,7 @@ import setuptools_scm
|
|||
|
||||
extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
'rst.linker',
|
||||
]
|
||||
|
||||
# General information about the project.
|
||||
|
@ -17,3 +18,22 @@ version = setuptools_scm.get_version(root='..', relative_to=__file__)
|
|||
release = version
|
||||
|
||||
master_doc = 'index'
|
||||
|
||||
link_files = {
|
||||
'CHANGES.rst': dict(
|
||||
using=dict(
|
||||
GH='https://github.com',
|
||||
project=project,
|
||||
),
|
||||
replace=[
|
||||
dict(
|
||||
pattern=r"(Issue )?#(?P<issue>\d+)",
|
||||
url='{GH}/jaraco/{project}/issues/{issue}',
|
||||
),
|
||||
dict(
|
||||
pattern=r"^(?m)((?P<scm_version>v?\d+(\.\d+){1,2}))\n[-=]+\n",
|
||||
with_scm="{text}\n{rev[timestamp]:%d %b %Y}\n",
|
||||
),
|
||||
],
|
||||
),
|
||||
}
|
||||
|
|
|
@ -5,4 +5,4 @@
|
|||
History
|
||||
*******
|
||||
|
||||
.. include:: ../CHANGES.rst
|
||||
.. include:: ../CHANGES (links).rst
|
||||
|
|
2
setup.py
2
setup.py
|
@ -13,7 +13,7 @@ with io.open('README.rst', encoding='utf-8') as readme:
|
|||
needs_pytest = {'pytest', 'test'}.intersection(sys.argv)
|
||||
pytest_runner = ['pytest_runner'] if needs_pytest else []
|
||||
needs_sphinx = {'release', 'build_sphinx', 'upload_docs'}.intersection(sys.argv)
|
||||
sphinx = ['sphinx'] if needs_sphinx else []
|
||||
sphinx = ['sphinx', 'rst.linker'] if needs_sphinx else []
|
||||
needs_wheel = {'release', 'bdist_wheel'}.intersection(sys.argv)
|
||||
wheel = ['wheel'] if needs_wheel else []
|
||||
|
||||
|
|
Loading…
Reference in New Issue
Block a user