summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJason Madden <jamadden@gmail.com>2020-04-03 05:53:27 -0500
committerJason Madden <jamadden@gmail.com>2020-04-06 09:14:45 -0500
commit139bab56a722ac9f350c55f24e47b2decd1c2e1e (patch)
tree77b3b965ccc516a7e5af7a9e53e3594e01a44b0d /docs
parent6c2f71487eed46896647edc9dc770f1fd5da823b (diff)
downloadzope-interface-139bab56a722ac9f350c55f24e47b2decd1c2e1e.tar.gz
Add more cross refs to documentation and fix a couple sphinx warnings about duplicates in the index.
Diffstat (limited to 'docs')
-rw-r--r--docs/README.rst9
-rw-r--r--docs/conf.py10
2 files changed, 17 insertions, 2 deletions
diff --git a/docs/README.rst b/docs/README.rst
index 831f19a..ff271a6 100644
--- a/docs/README.rst
+++ b/docs/README.rst
@@ -299,6 +299,9 @@ Note that class decorators using the ``@implementer(IFoo)`` syntax are only
supported in Python 2.6 and later.
.. autofunction:: implementer
+ :noindex:
+
+ .. XXX: Duplicate description.
Declaring provided interfaces
-----------------------------
@@ -416,6 +419,9 @@ We can find out what interfaces are directly provided by an object:
[]
.. autofunction:: provider
+ :noindex:
+
+ .. XXX: Duplicate description.
Inherited declarations
----------------------
@@ -472,6 +478,7 @@ be used for this purpose:
[<InterfaceClass builtins.IFoo>]
.. autofunction:: classImplements
+ :noindex:
We can use ``classImplementsOnly`` to exclude inherited interfaces:
@@ -485,7 +492,9 @@ We can use ``classImplementsOnly`` to exclude inherited interfaces:
[<InterfaceClass builtins.ISpecial>]
.. autofunction:: classImplementsOnly
+ :noindex:
+ .. XXX: Duplicate description.
Declaration Objects
-------------------
diff --git a/docs/conf.py b/docs/conf.py
index 464f652..59dac0d 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -264,6 +264,12 @@ texinfo_documents = [
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None}
-autodoc_default_flags = ['members', 'show-inheritance']
-autoclass_content = 'both'
+# Sphinx 1.8+ prefers this to `autodoc_default_flags`. It's documented that
+# either True or None mean the same thing as just setting the flag, but
+# only None works in 1.8 (True works in 2.0)
+autodoc_default_options = {
+ 'members': None,
+ 'show-inheritance': None,
+}
autodoc_member_order = 'bysource'
+autoclass_content = 'both'