diff options
| author | Marc Mueller <30130371+cdce8p@users.noreply.github.com> | 2021-06-16 20:13:21 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-06-16 20:13:21 +0200 |
| commit | 485a1980860178bcd3345597d76b5688f1c1d84a (patch) | |
| tree | 1c545ff826d62a344ff417966f9a9beecdd92b91 /doc | |
| parent | 61f670d98a8c14f9f4e71e88c2a0e84f4999bac3 (diff) | |
| download | astroid-git-485a1980860178bcd3345597d76b5688f1c1d84a.tar.gz | |
Improve Sphinx config (#1001)
* Update and pin Sphinx version
* Update conf
* Group class members
* Display typehints in description
* Update tox so doc env isn't reused
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/conf.py | 8 | ||||
| -rw-r--r-- | doc/requirements.txt | 2 |
2 files changed, 8 insertions, 2 deletions
diff --git a/doc/conf.py b/doc/conf.py index 12070636..4602a3f4 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -231,7 +231,13 @@ man_pages = [ ['Logilab, PyCQA and contributors'], 1) ] -autodoc_default_flags = ['members', 'undoc-members', 'show-inheritance'] +autodoc_default_options = { + 'members': True, + 'undoc-members': True, + 'show-inheritance': True, +} +autodoc_member_order = "groupwise" +autodoc_typehints = 'description' intersphinx_mapping = { 'green_tree_snakes': ('http://greentreesnakes.readthedocs.io/en/latest/', 'ast_objects.inv'), diff --git a/doc/requirements.txt b/doc/requirements.txt index 96c342cd..3c1df6a6 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,2 +1,2 @@ -e . -sphinx +sphinx~=4.0 |