Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
stefanDeveloper committed Mar 25, 2024
1 parent e18503b commit 4ef9d1a
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
sphinx==7.1.2
sphinx-rtd-theme==1.3.0rc1
sphinxcontrib.apidoc==0.5.0
sphinx_autodoc_typehints==2.0.0
sphinx_autodoc_typehints==2.0.0
nbsphinx==0.9.3
myst_parser==2.0.0
sphinx_design==0.5.0
30 changes: 30 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,17 @@
release = '0.1'
version = '0.1.0'

# -- Path setup --------------------------------------------------------------

# 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.
#
import os
import sys

sys.path.insert(0, os.path.abspath('../..'))

# -- General configuration

extensions = [
Expand All @@ -22,7 +33,11 @@
'sphinx.ext.viewcode',
'sphinx.ext.napoleon',
'sphinx_autodoc_typehints',
'sphinx.ext.autosummary',
'sphinxcontrib.apidoc', # automatically generate API docs, see https://github.com/rtfd/readthedocs.org/issues/1139
'nbsphinx',
'myst_parser',
'sphinx_design',
]

# -- apidoc settings ---------------------------------------------------------
Expand All @@ -33,6 +48,21 @@
apidoc_separate_modules = True
apidoc_extra_args = ['-d 6']


# Napoleon settings
napoleon_google_docstring = True
napoleon_numpy_docstring = True
napoleon_include_init_with_doc = True
napoleon_include_private_with_doc = False
napoleon_include_special_with_doc = True
napoleon_use_admonition_for_examples = False
napoleon_use_admonition_for_notes = False
napoleon_use_admonition_for_references = False
napoleon_use_ivar = False
napoleon_use_param = True
napoleon_use_rtype = False


intersphinx_mapping = {
'python': ('https://docs.python.org/3/', None),
'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
Expand Down

0 comments on commit 4ef9d1a

Please sign in to comment.