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

Close #8132: Add project_copyright confval as an alias of copyright

Browse Source 
Avoid to pylint error, add a new config variable; project_copyright
as an alias of `copyright`.
This commit is contained in:
Takeshi KOMIYA 2020-12-27 18:39:48 +09:00
parent 4fc93ac13c
commit c7d1536828
3 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES
View File

@ -13,6 +13,8 @@ Deprecated
Features added
--------------
* #8132: Add :confval:`project_copyright` as an alias of :confval:`copyright`
Bugs fixed
----------

5
doc/usage/configuration.rst
View File

@ -70,9 +70,14 @@ Project information
The author name(s) of the document. The default value is ``'unknown'``.
.. confval:: copyright
.. confval:: project_copyright
A copyright statement in the style ``'2008, Author Name'``.
.. versionchanged:: 3.5
As an alias, ``project_copyright`` is also allowed.
.. confval:: version
The major project version, used as the replacement for ``|version|``. For

3
sphinx/config.py
View File

@ -98,7 +98,8 @@ class Config:
# general options
'project': ('Python', 'env', []),
'author': ('unknown', 'env', []),
'copyright': ('', 'html', []),
'project_copyright': ('', 'html', [str]),
'copyright': (lambda c: c.project_copyright, 'html', [str]),
'version': ('', 'env', []),
'release': ('', 'env', []),
'today': ('', 'env', []),