From b7ebe3d247e440eaeaea0baa1ba6bf6ef206e8ce Mon Sep 17 00:00:00 2001 From: Baudouin Raoult Date: Tue, 28 May 2024 10:07:14 +0100 Subject: [PATCH] Update doc --- docs/conf.py | 8 ++------ docs/index.rst | 6 +++--- docs/requirements.txt | 1 + 3 files changed, 6 insertions(+), 9 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index aa1a927..f8fbad2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -14,14 +14,9 @@ import os import sys -sys.path.insert(0, os.path.join(os.path.abspath(".."), "src")) - - read_the_docs_build = os.environ.get("READTHEDOCS", None) == "True" -# top = os.path.realpath(os.path.dirname(os.path.dirname(__file__))) -# sys.path.insert(0, top) - +sys.path.insert(0, os.path.join(os.path.abspath(".."), "src")) source_suffix = ".rst" master_doc = "index" @@ -65,6 +60,7 @@ "sphinx.ext.intersphinx", "sphinx.ext.autodoc", "sphinx.ext.napoleon", + "sphinxarg.ext", ] # Add any paths that contain templates here, relative to this directory. diff --git a/docs/index.rst b/docs/index.rst index 3752c16..025a29f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,9 +2,9 @@ .. _index-page: -#################################### - Welcome to Anemoi's documentation! -#################################### +########################################## + Welcome to `anemoi-utils` documentation! +########################################## .. warning:: diff --git a/docs/requirements.txt b/docs/requirements.txt index c85e9f1..8b8bccd 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,6 +2,7 @@ sphinx sphinx_rtd_theme nbsphinx +sphinx_argparse # Also requires `brew install pandoc` on Mac pandoc