mc doc
This commit is contained in:
parent
d960ccd007
commit
2b64516ad1
6 changed files with 0 additions and 0 deletions
40
docs/conf.py
Normal file
40
docs/conf.py
Normal file
|
@ -0,0 +1,40 @@
|
|||
import os
|
||||
import sys
|
||||
sys.path.insert(0, os.path.abspath('../optifik'))
|
||||
|
||||
# Configuration file for the Sphinx documentation builder.
|
||||
#
|
||||
# For the full list of built-in configuration values, see the documentation:
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
||||
|
||||
project = 'optifik'
|
||||
copyright = '2025, F. Boulogne et al.'
|
||||
author = 'F. Boulogne et al.'
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
||||
|
||||
extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
'sphinx.ext.napoleon',
|
||||
'sphinx.ext.viewcode',
|
||||
]
|
||||
|
||||
templates_path = ['_templates']
|
||||
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
||||
|
||||
|
||||
|
||||
# -- Options for HTML output -------------------------------------------------
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
||||
|
||||
html_theme = 'alabaster'
|
||||
html_static_path = ['_static']
|
||||
|
||||
|
||||
napoleon_google_docstring = False
|
||||
napoleon_numpy_docstring = True
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue