From 24734d6a9631830b66d212683350dc248ed5bd2d Mon Sep 17 00:00:00 2001 From: gwen Date: Wed, 21 Jun 2023 17:55:21 +0200 Subject: [PATCH] doc --- actes-princiers/docs/Readme.rst | 14 ++++++++++++++ actes-princiers/docs/source/conf.py | 14 +++++++------- actes-princiers/src/requirements.txt | 1 + 3 files changed, 22 insertions(+), 7 deletions(-) create mode 100644 actes-princiers/docs/Readme.rst diff --git a/actes-princiers/docs/Readme.rst b/actes-princiers/docs/Readme.rst new file mode 100644 index 0000000..313ed3b --- /dev/null +++ b/actes-princiers/docs/Readme.rst @@ -0,0 +1,14 @@ +Documentation +===================== + +Pour lancer le build de la doc, taper:: + + sphinx-build -b html source build + +Pour consulter la documentation en HTML, lancer:: + + python -m"http.server" --directory ./build/ + +Ouvrir un navigateur, et allez à l'url suivante:: + + localhost:8000/ diff --git a/actes-princiers/docs/source/conf.py b/actes-princiers/docs/source/conf.py index 493a920..6da395c 100644 --- a/actes-princiers/docs/source/conf.py +++ b/actes-princiers/docs/source/conf.py @@ -21,7 +21,8 @@ import re from kedro.framework.cli.utils import find_stylesheets -from actes_princiers import __version__ as release +#from actes_princiers import __version__ as release +release = "0.1" # -- Project information ----------------------------------------------------- @@ -43,14 +44,12 @@ version = re.match(r"^([0-9]+\.[0-9]+).*", release).group(1) extensions = [ "sphinx.ext.autodoc", "sphinx.ext.napoleon", - "sphinx_autodoc_typehints", "sphinx.ext.todo", "sphinx.ext.coverage", "sphinx.ext.ifconfig", "sphinx.ext.viewcode", - "nbsphinx", - "myst_parser", - "sphinx_copybutton", + #"nbsphinx", + #"sphinx_copybutton", ] # enable autosummary plugin (table of contents for modules/classes/class @@ -73,7 +72,7 @@ master_doc = "index" # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = 'fr' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -88,7 +87,8 @@ pygments_style = "sphinx" # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = "sphinx_rtd_theme" +# html_theme = "sphinx_rtd_theme" +html_theme = "bizstyle" # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the diff --git a/actes-princiers/src/requirements.txt b/actes-princiers/src/requirements.txt index 2ba1087..127ecc8 100644 --- a/actes-princiers/src/requirements.txt +++ b/actes-princiers/src/requirements.txt @@ -1,4 +1,5 @@ pandas>=2.0.2 +nbsphinx>=0.9.2 lxml>=4.6.3 python-slugify>=8.0.1 black~=22.0