From 517c532c89941463ff3136b1697f8e43c1b44ba4 Mon Sep 17 00:00:00 2001 From: Markus Pichler Date: Mon, 12 Aug 2024 16:26:33 +0200 Subject: [PATCH] docs: fixed error in doc config --- documentation/conf.py | 7 +++++-- documentation/index.rst | 2 ++ pyproject.toml | 2 +- 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/documentation/conf.py b/documentation/conf.py index a705425..3961c59 100644 --- 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 index 1607d1f..6d5756f 100644 --- 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 index e612497..8f17fa7 100644 --- 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/"