diff --git a/.gitignore b/.gitignore index 6b7a229e28d482c7884b5cdccd5994fe3659e153..3d8beea8946d82c79278f787fe798464b4c1203e 100644 --- a/.gitignore +++ b/.gitignore @@ -7,4 +7,5 @@ result .vscode .cache compile_commands.json -export_path_for_tests \ No newline at end of file +export_path_for_tests +docs/_build \ No newline at end of file diff --git a/default.nix b/default.nix index 6ddd2e1f9d40388be6375a946af744a3f80efdff..07dbc11c64cc3d5b9dfd74d47dc8fa08da514c09 100644 --- a/default.nix +++ b/default.nix @@ -74,6 +74,12 @@ let pandas ]; }; + + doc = pkgs.stdenv.mkDerivation rec { + name = "sphinx-documentation"; + buildInputs = with pythonPackages; [ sphinx sphinx_rtd_theme myst-parser ]; + }; + }; diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000000000000000000000000000000000000..d4bb2cbb9eddb1bb1b4f366623044af8e4830919 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/conf.py b/docs/conf.py index ecf6c3a8fc18981cf0179e5089639192b16f2979..543b7bd97c442bf7e1cc3cdd25ec1424792ce7b8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,15 +1,17 @@ # 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 +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information project = 'Batmen' -copyright = '2021-2024, Maël Madon' -author = 'Maël Madon' +copyright = '2024, Maël Madon, Millian Poquet, Jolyne Gatt' +author = 'Maël Madon, Millian Poquet, Jolyne Gatt' -release = '' -version = '' - -# -- General configuration +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration extensions = [ 'myst_parser' @@ -17,14 +19,11 @@ extensions = [ source_suffix = ['.rst', '.md'] -# intersphinx_mapping = { -# 'python': ('https://docs.python.org/3/', None), -# 'sphinx': ('https://www.sphinx-doc.org/en/master/', None), -# } -# intersphinx_disabled_domains = ['std'] - -templates_path = ['_templates'] +# templates_path = ['_templates'] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] -# -- Options for HTML output +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -html_theme = 'sphinx_rtd_theme' \ No newline at end of file +html_theme = 'sphinx_rtd_theme' +# html_static_path = ['_static'] diff --git a/docs/index.rst b/docs/index.rst index 4678e953a6b208ac9d46169cd31396df05337259..173a1befb9e02c08fdda678472dd56072199c481 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,27 +1,22 @@ -.. Sphinx with Markdown documentation master file, created by - sphinx-quickstart on Thu Oct 6 19:07:54 2016. +.. Batmen documentation master file, created by + sphinx-quickstart on Tue Jun 18 10:38:15 2024. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Batmen documentation -================================================ - -TODO - -Contents: +Welcome to Batmen's documentation! +================================== .. toctree:: :maxdepth: 2 + :caption: Contents: -.. question.md -.. answer.md -.. answer_beni.md + user_categories.md -.. Indices and tables -.. ================== +Indices and tables +================== -.. * :ref:`genindex` -.. * :ref:`modindex` -.. * :ref:`search` \ No newline at end of file +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/user_categories.md b/docs/user_categories.md new file mode 100644 index 0000000000000000000000000000000000000000..4c99d8cab554c2f584b196a63075cc43f7da88d8 --- /dev/null +++ b/docs/user_categories.md @@ -0,0 +1,15 @@ +# User categories + +TODO description générale... + +## Modelled users +TODO + +## Replay users +TODO + +## Feedback users +TODO + +## Feedback and replay users +TODO \ No newline at end of file