diff options
| author | Michael Goerz <goerz@stanford.edu> | 2019-03-10 18:37:05 -0400 |
|---|---|---|
| committer | Michael Goerz <goerz@stanford.edu> | 2019-03-10 18:37:05 -0400 |
| commit | 1f136215c18fc75eb9402ec7da083f9022703d71 (patch) | |
| tree | d09441b44372dcaf7b7899f19202bfa17329f0f2 /doc/conf.py | |
| parent | 332dd5d89f7d5f3135006580c5702bb83843d476 (diff) | |
| download | sphinx-git-1f136215c18fc75eb9402ec7da083f9022703d71.tar.gz | |
Fix docs of inheritance-diagram "parts" option
The documentation now correctly describes the behavior of the ``parts``
option in an inheritance-diagram directive: it gives the number of parts
that are *kept* not dropped. The option now also accepts negative
values, which drops parts from the left (which is the what the
documentation incorrectly claimed the option would do for positive
values)
As a form of testing of the new functionality, the documentation for the
inheritance_diagram extension now includes a section "Examples" that
demonstrate the different possibilities. This would fail to build
without the patch.
Closes #4872
Diffstat (limited to 'doc/conf.py')
| -rw-r--r-- | doc/conf.py | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/conf.py b/doc/conf.py index 58cbfe708..f29180f77 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -7,7 +7,7 @@ import sphinx extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', 'sphinx.ext.autosummary', 'sphinx.ext.extlinks', - 'sphinx.ext.viewcode'] + 'sphinx.ext.viewcode', 'sphinx.ext.inheritance_diagram'] master_doc = 'contents' templates_path = ['_templates'] |