Collapse Python API and Contracts API into one APIS section in sidebar.

pull/2463/head
derekpierre 2021-02-03 16:04:05 -05:00
parent 3b6d47dfe3
commit 0285153c44
3 changed files with 9 additions and 20 deletions

View File

@ -89,11 +89,7 @@ language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = [
'api/nucypher.rst',
'api/modules.rst',
'api/nucypher.cli*'
]
exclude_patterns = []
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = None
@ -239,6 +235,7 @@ def run_apidoc(_):
apidoc_command.extend(['-fME',
'-t', f'{source_dir / "apidoc"}',
'-o', f'{source_dir / "api"}',
'-H', 'Python API',
f'{nucypher_module_dir}'])
# ---- exclusion patterns (*must be last to be added*) ----
@ -255,6 +252,7 @@ def run_apidoc(_):
Path('nucypher', 'utilities'),
Path('nucypher', 'blockchain', 'eth', 'sol'),
Path('nucypher', 'blockchain', 'eth', 'economics.py'),
Path('nucypher', 'cli')
]
for exclusion_item in exclusion_items:
apidoc_command.append(f'{nucypher_module_dir / exclusion_item}')

View File

@ -1,3 +1,7 @@
=============
Contracts API
=============
Token contracts
===============

View File

@ -134,22 +134,9 @@ Whitepapers
.. toctree::
:maxdepth: 1
:caption: Python API
api/nucypher.blockchain
api/nucypher.characters
api/nucypher.config
api/nucypher.policy
api/nucypher.network
api/nucypher.datastore
api/nucypher.crypto
api/nucypher.acumen
.. toctree::
:maxdepth: 1
:glob:
:caption: Contracts API
:caption: APIS
api/modules
contracts_api/index
.. toctree::