docs: fixed error in doc config

MarkusPic · Aug 12, 2024 · 517c532 · 517c532
1 parent cb6f64e
commit 517c532
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 3 deletions.
diff --git a/documentation/conf.py b/documentation/conf.py
@@ -55,7 +55,10 @@
     'sphinx.ext.extlinks',
     'sphinx.ext.napoleon',  # numpy/google docstrings
     'nbsphinx',  # jupyter notebook
-    'recommonmark'  # markdown
+    # 'recommonmark',  # markdown old
+    'myst_parser',  # markdown new
+    'sphinx.ext.duration',
+    'sphinx_codeautolink',  # automatic links from code to documentation # https://sphinx-codeautolink.readthedocs.io/en/latest/index.html
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -108,7 +111,7 @@
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
-# html_theme_options = {}
+html_theme_options = {'sidebarwidth': 350}
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

diff --git a/documentation/index.rst b/documentation/index.rst
@@ -15,6 +15,8 @@ Welcome to Intensity Duration Frequency Analyse's documentation!
    base_functions
    examples/example_commandline
    examples/example_python_api
+   examples/example_heavy_rainfall_index
+   examples/example_python_api_extended
 
 
 Indices and tables

diff --git a/pyproject.toml b/pyproject.toml
@@ -37,7 +37,7 @@ dependencies = [
 dynamic = ["version"]
 
 [project.optional-dependencies]
-docs = ["sphinx", "nbsphinx", "recommonmark", "pydata_sphinx_theme", "ipython==8.5.0"]
+docs = ["sphinx", "nbsphinx", "recommonmark", "myst-parser", "pydata_sphinx_theme", "ipython==8.5.0", 'sphinx-codeautolink']
 
 [project.urls]
 Documentation = "https://markuspic.github.io/intensity_duration_frequency_analysis/"