diff options
author | Étienne Loks <etienne.loks@iggdrasil.net> | 2024-05-03 17:54:18 +0200 |
---|---|---|
committer | Étienne Loks <etienne.loks@iggdrasil.net> | 2024-05-06 12:43:15 +0200 |
commit | e770c12bf36346d7f7580e20ea3f1c4386a94ee3 (patch) | |
tree | fd20f879e823ee37332a7f6b0159be5b78d0ba21 /docs | |
parent | fa19e9f25404a3363169909ff02a5cac32bd8cdc (diff) | |
download | Ishtar-e770c12bf36346d7f7580e20ea3f1c4386a94ee3.tar.bz2 Ishtar-e770c12bf36346d7f7580e20ea3f1c4386a94ee3.zip |
📝 new theme for readthedocs, logos, favicon, etc.
- use book theme
- add subsection to menu
- add logo for dark and light mode
- add a favicon
- remove download button
- add section description on index page
Diffstat (limited to 'docs')
-rw-r--r-- | docs/fr/source/_static/favicon.png | bin | 0 -> 6616 bytes | |||
-rw-r--r-- | docs/fr/source/_static/logo-ishtar-dark.png | bin | 0 -> 14441 bytes | |||
-rwxr-xr-x | docs/fr/source/_static/logo-ishtar-light.png | bin | 0 -> 3534 bytes | |||
-rw-r--r-- | docs/fr/source/conf.py | 14 | ||||
-rw-r--r-- | docs/fr/source/index.rst | 45 | ||||
-rw-r--r-- | docs/fr/source/utilisateur.rst | 6 |
6 files changed, 51 insertions, 14 deletions
diff --git a/docs/fr/source/_static/favicon.png b/docs/fr/source/_static/favicon.png Binary files differnew file mode 100644 index 000000000..c4b51a45e --- /dev/null +++ b/docs/fr/source/_static/favicon.png diff --git a/docs/fr/source/_static/logo-ishtar-dark.png b/docs/fr/source/_static/logo-ishtar-dark.png Binary files differnew file mode 100644 index 000000000..e79ba96a8 --- /dev/null +++ b/docs/fr/source/_static/logo-ishtar-dark.png diff --git a/docs/fr/source/_static/logo-ishtar-light.png b/docs/fr/source/_static/logo-ishtar-light.png Binary files differnew file mode 100755 index 000000000..d81121346 --- /dev/null +++ b/docs/fr/source/_static/logo-ishtar-light.png diff --git a/docs/fr/source/conf.py b/docs/fr/source/conf.py index 93595d225..f2a8f8d6d 100644 --- a/docs/fr/source/conf.py +++ b/docs/fr/source/conf.py @@ -102,12 +102,20 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. #html_theme = 'default' -html_theme = "sphinx_rtd_theme" +#html_theme = "sphinx_rtd_theme" +html_theme = "sphinx_book_theme" # 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 # documentation. #html_theme_options = {} +html_theme_options = { + "use_download_button": False, + "logo": { + "image_light": "_static/logo-ishtar-light.png", + "image_dark": "_static/logo-ishtar-dark.png", + } +} # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] @@ -126,7 +134,7 @@ html_theme = "sphinx_rtd_theme" # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -#html_favicon = None +html_favicon = "_static/favicon.png" # 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, @@ -229,5 +237,5 @@ man_pages = [ def setup(app): - app.add_stylesheet('css/custom.css') + app.add_css_file('css/custom.css') diff --git a/docs/fr/source/index.rst b/docs/fr/source/index.rst index f2c56a0d6..2a28391c7 100644 --- a/docs/fr/source/index.rst +++ b/docs/fr/source/index.rst @@ -1,24 +1,53 @@ -.. Ishtar documentation master file, created by - sphinx-quickstart on Wed Oct 12 01:01:02 2011. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. +Documentation d'Ishtar +====================== -Bienvenue dans la documentation d'Ishtar ! -========================================== +Utilisation d'Ishtar +-------------------- -Contents: +Les sections suivantes décrivent les principes généraux du logiciel et explicitent son fonctionnement. .. toctree:: - :maxdepth: 3 + :maxdepth: 2 + :caption: Utilisation principes utilisateur + +Installation/configuration +-------------------------- + +Les sections suivantes décrivent le paramétrage et l'installation du logiciel. Le paramétrage dit « applicatif » concerne les utilisateurs de l'application disposant d'un profil administrateur. Ce paramétrage se fait au sein de l'application. + +.. toctree:: + :maxdepth: 2 + :caption: Installation/configuration + administrateur-applicatif administrateur-serveur + +Annexes pour l'utilisateur +-------------------------- + +Ces annexes sont à destination des utilisateurs ou des administrateurs applicatifs de l'application. + +.. toctree:: + :maxdepth: 2 + :caption: Annexes pour l'utilisateur + annexe-1-permission-action annexe-2-ex-flux-ope annexe-3-doc-normes annexe-4-champs + +Annexes techniques +------------------ + +Ces annexes sont à destination de l'administrateur serveur ou concernent des usages avancés pour les administrateurs applicatifs. + +.. toctree:: + :maxdepth: 2 + :caption: Annexes techniques + annexe-tech-1-insee-communes annexe-tech-2-ign-communes annexe-tech-3-variables-gen diff --git a/docs/fr/source/utilisateur.rst b/docs/fr/source/utilisateur.rst index c3659117b..c34d08f63 100644 --- a/docs/fr/source/utilisateur.rst +++ b/docs/fr/source/utilisateur.rst @@ -1,8 +1,8 @@ .. -*- coding: utf-8 -*- -=========== -Utilisateur -=========== +======================== +Documentation utilisateur +======================== :Auteur: Étienne Loks :Date: 2018-10-02 |