diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..cd4b8ca --- /dev/null +++ b/docs/README.md @@ -0,0 +1,11 @@ +# Two docs + +``` +export TMPDIR=$(mktemp -d) +python -m venv ${TMPDIR}/venv +python3 -m venv "${TMPDIR}/venv" +source "${TMPDIR}/venv/bin/activate" +python3.14 -m pip install --upgrade pip +pip3.14 install -r requirements.txt +sphinx-autobuild . "${TMPDIR}/build" +``` diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html new file mode 100644 index 0000000..a4de09b --- /dev/null +++ b/docs/_templates/layout.html @@ -0,0 +1,6 @@ +{% extends "!layout.html" %} + +{%- block extrahead %} + + +{% endblock %} diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..f59d7df --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,36 @@ +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +project = 'Two doc\'s' +copyright = '2023, Nicolas Boufidjeline' +author = 'Nicolas Boufidjeline' + + +# -- General configuration --------------------------------------------------- + +templates_path = ['_templates'] +exclude_patterns = [] + +language = 'fr' + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = 'sphinx_book_theme' +html_static_path = [] + +extensions = [ + 'myst_parser', + 'sphinxcontrib.mermaid' +] + +html_show_sphinx = False + +source_suffix = { + '.rst': 'restructuredtext', +} diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..641da91 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,9 @@ +Two +=== + +.. toctree:: + :hidden: + + installation/index + +Cecie est la doc qui est utiliser pour parler de moi de mes projet en cours fini ou annuler et aussi de mes resultat de test diff --git a/docs/installation/index.rst b/docs/installation/index.rst new file mode 100644 index 0000000..798d94f --- /dev/null +++ b/docs/installation/index.rst @@ -0,0 +1,4 @@ +Installation +============ + +Cecie est la doc qui est utiliser pour parler de moi de mes projet en cours fini ou annuler et aussi de mes resultat de test diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..3048e63 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,5 @@ +sphinx==9.1.0 +sphinx-autobuild==2025.8.25 +sphinx-book-theme==1.2.0 +myst-parser==5.1.0 +sphinxcontrib.mermaid==2.0.2