Skip to content

Commit ac241d9

Browse files
committed
add more metadata
1 parent 14957a4 commit ac241d9

2 files changed

Lines changed: 23 additions & 11 deletions

File tree

docs/conf.py

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,11 @@
6969
# The master toctree document.
7070
master_doc = 'index'
7171

72-
autodoc_default_flags = ['show_inheritance', 'autosummary']
72+
autodoc_default_options = {
73+
'show_inheritance': True,
74+
'autosummary': True,
75+
}
76+
7377
autoclass_content = 'both'
7478

7579
not_document_data = ['psyplot_gui.config.rcsetup.defaultParams',
@@ -78,16 +82,16 @@
7882
ipython_savefig_dir = os.path.join(os.path.dirname(__file__), '_static')
7983

8084
# General information about the project.
81-
project = u'psyplot_gui'
82-
copyright = u'2016, Philipp Sommer'
83-
author = u'Philipp Sommer'
85+
project = 'psyplot-gui'
86+
copyright = psyplot_gui.__copyright__
87+
author = psyplot_gui.__author__
8488

8589
# The version info for the project you're documenting, acts as replacement for
8690
# |version| and |release|, also used in various other places throughout the
8791
# built documents.
8892
#
8993
# The short X.Y version.
90-
version = re.match('\d+\.\d+\.\d+', psyplot_gui.__version__).group()
94+
version = re.match(r'\d+\.\d+\.\d+', psyplot_gui.__version__).group()
9195
# The full version, including alpha/beta/rc tags.
9296
release = psyplot_gui.__version__
9397

@@ -140,16 +144,16 @@
140144
# (source start file, target name, title,
141145
# author, documentclass [howto, manual, or own class]).
142146
latex_documents = [
143-
(master_doc, 'psyplot_gui.tex', u'psyplot GUI Documentation',
144-
u'Philipp Sommer', 'manual'),
147+
(master_doc, 'psyplot-gui.tex', u'psyplot GUI Documentation',
148+
author, 'manual'),
145149
]
146150

147151
# -- Options for manual page output ---------------------------------------
148152

149153
# One entry per manual page. List of tuples
150154
# (source start file, name, description, authors, manual section).
151155
man_pages = [
152-
(master_doc, 'psyplot_gui', u'psyplot GUI Documentation',
156+
(master_doc, 'psyplot-gui', u'psyplot GUI Documentation',
153157
[author], 1)
154158
]
155159

@@ -159,8 +163,8 @@
159163
# (source start file, target name, title, author,
160164
# dir menu entry, description, category)
161165
texinfo_documents = [
162-
(master_doc, 'psyplot_gui', u'psyplot GUI Documentation',
163-
author, 'psyplot_gui', 'Graphical user interface for the psyplot package',
166+
(master_doc, 'psyplot-gui', u'psyplot GUI Documentation',
167+
author, 'psyplot-gui', 'Graphical user interface for the psyplot package',
164168
'Visualization'),
165169
]
166170

psyplot_gui/__init__.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,15 @@
2727

2828
from psyplot.compat.pycompat import get_default_value
2929

30-
__author__ = "Philipp Sommer ([email protected])"
30+
__author__ = "Philipp S. Sommer"
31+
__copyright__ = "Copyright 2016 - 2020, Philipp S. Sommer"
32+
__credits__ = ["Philipp S. Sommer"]
33+
__license__ = "GPL-2.0-only"
34+
35+
__maintainer__ = "Philipp S. Sommer"
36+
__email__ = "[email protected]"
37+
38+
__status__ = "Production"
3139

3240
logger = logging.getLogger(__name__)
3341
logger.debug(

0 commit comments

Comments
 (0)