Skip to content

Commit 74ff58a

Browse files
committed
minor fixes for building the docs
1 parent aca7ed7 commit 74ff58a

File tree

6 files changed

+12
-18
lines changed

6 files changed

+12
-18
lines changed

README.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,7 @@ directives by adding in ``conf.py``:
128128
Disclaimer
129129
==========
130130
Copyright 2016-2019, Philipp S. Sommer
131+
131132
Copyright 2020-2021, Helmholtz-Zentrum Hereon
132133

133134
Licensed under the Apache License, Version 2.0 (the "License");

autodocsumm/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
**Disclaimer**
1111
1212
Copyright 2016-2019, Philipp S. Sommer
13+
1314
Copyright 2020-2021, Helmholtz-Zentrum Hereon
1415
1516
Licensed under the Apache License, Version 2.0 (the "License");

docs/api/autodocsumm.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,5 @@ API Reference
33

44
.. automodule:: autodocsumm
55
:members:
6-
:undoc-members:
76
:show-inheritance:
87

docs/conf.py

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,9 @@
6969
add_module_names = False
7070

7171
# General information about the project.
72-
project = u'autodocsumm'
73-
copyright = u'2015, Philipp Sommer'
74-
author = u'Philipp Sommer'
72+
project = 'autodocsumm'
73+
copyright = '2016-2019, Philipp S. Sommer; 2020-2021, Helmholtz-Zentrum Hereon'
74+
author = 'Philipp S. Sommer'
7575

7676
# The version info for the project you're documenting, acts as replacement for
7777
# |version| and |release|, also used in various other places throughout the
@@ -137,11 +137,6 @@
137137
html_theme = 'sphinx_rtd_theme'
138138
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
139139

140-
# Add any paths that contain custom static files (such as style sheets) here,
141-
# relative to this directory. They are copied after the builtin static files,
142-
# so a file named "default.css" will overwrite the builtin "default.css".
143-
html_static_path = ['_static']
144-
145140
# otherwise, readthedocs.org uses their theme by default, so no need to specify
146141

147142
# Theme options are theme-specific and customize the look and feel of a theme
@@ -385,12 +380,9 @@
385380

386381
# Example configuration for intersphinx: refer to the Python standard library.
387382
intersphinx_mapping = {
388-
'sphinx': ('http://www.sphinx-doc.org/en/master/', None),
383+
'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
384+
'python': ('https://docs.python.org/3.9/', None),
389385
}
390-
if six.PY3:
391-
intersphinx_mapping['python'] = ('https://docs.python.org/3.7/', None)
392-
else:
393-
intersphinx_mapping['python'] = ('https://docs.python.org/2.7/', None)
394386

395387

396388
def example_grouper(app, what, name, obj, section, parent):

docs/conf_settings.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,9 @@ Directives
7171
use the same options as for the ``autoclass`` directive. You can select a
7272
specific section and omit the title via::
7373

74-
.. autoclasssumm:: MyClass
75-
:autosummary-sections: Methods
76-
:autosummary-no-titles:
74+
.. autoclasssumm:: MyClass
75+
:autosummary-sections: Methods
76+
:autosummary-no-titles:
7777

7878
By default, this directives also sets the `:members:` option unless you
7979
specify `:no-members`.

docs/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ directives to generate a table at the top, e.g.:
127127

128128
.. code-block:: rst
129129
130-
.. automodule:: my.awesome.module
130+
.. automodule:: autodocsumm
131131
:autosummary:
132132
133133
Optionally, you can make autodocsumm active by default for all autodoc
@@ -144,6 +144,7 @@ directives by adding:
144144
Disclaimer
145145
==========
146146
Copyright 2016-2019, Philipp S. Sommer
147+
147148
Copyright 2020-2021, Helmholtz-Zentrum Hereon
148149

149150
Licensed under the Apache License, Version 2.0 (the "License");

0 commit comments

Comments
 (0)