docs: add first doc version
Signed-off-by: GnomeZworc <nicolas.boufidjeline@g3e.fr>
This commit is contained in:
parent
10c9bc2985
commit
9a46b5cde7
6 changed files with 71 additions and 0 deletions
11
docs/README.md
Normal file
11
docs/README.md
Normal file
|
|
@ -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"
|
||||||
|
```
|
||||||
6
docs/_templates/layout.html
vendored
Normal file
6
docs/_templates/layout.html
vendored
Normal file
|
|
@ -0,0 +1,6 @@
|
||||||
|
{% extends "!layout.html" %}
|
||||||
|
|
||||||
|
{%- block extrahead %}
|
||||||
|
<link rel="stylesheet" type="text/css" href="{{ pathto('_static/handsontable.full.min.css', 1) }}">
|
||||||
|
<script src="{{ pathto('_static/handsontable.full.min.js', 1) }}"></script>
|
||||||
|
{% endblock %}
|
||||||
36
docs/conf.py
Normal file
36
docs/conf.py
Normal file
|
|
@ -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',
|
||||||
|
}
|
||||||
9
docs/index.rst
Normal file
9
docs/index.rst
Normal file
|
|
@ -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
|
||||||
4
docs/installation/index.rst
Normal file
4
docs/installation/index.rst
Normal file
|
|
@ -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
|
||||||
5
docs/requirements.txt
Normal file
5
docs/requirements.txt
Normal file
|
|
@ -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
|
||||||
Loading…
Add table
Add a link
Reference in a new issue