Skip to content

Commit

Permalink
Test new autoapi version
Browse files Browse the repository at this point in the history
  • Loading branch information
evilaliv3 committed Nov 8, 2023
1 parent e48b814 commit 3b2d692
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 2 deletions.
14 changes: 12 additions & 2 deletions documentation/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath('../backend/globaleaks/'))
sys.path.insert(0, os.path.abspath('../backend/'))

# -- General configuration ------------------------------------------------

Expand All @@ -28,7 +28,10 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx_rtd_theme'
'autoapi.sphinx',
'sphinx.ext.autodoc',
'sphinx.ext.inheritance_diagram',
'sphinx_rtd_theme'
]

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -278,5 +281,12 @@
'style_nav_header_background': '#377abc',
}

autoapi_modules = {
'globaleaks': {
'override': False,
'output': 'developer/globaleaks'
}
}

def setup(app):
app.add_css_file("custom.css")
7 changes: 7 additions & 0 deletions documentation/developer/CodeDocumentation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Code Documentation
==================

.. toctree::
:hidden:

globaleaks/globaleaks
1 change: 1 addition & 0 deletions documentation/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
autoapi
sphinx
sphinx_rtd_theme

0 comments on commit 3b2d692

Please sign in to comment.