From 7f80626ebad28d3c201464720cdf9533ff38a5a0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ma=C3=ABl=20Madon?= <mael.madon@irit.fr>
Date: Mon, 17 Jun 2024 17:12:43 +0200
Subject: [PATCH] doc: additionnal required files for sphinx
---
docs/conf.py | 8 +++-----
docs/index.rst | 27 +++++++++++++++++++++++++++
docs/requirements.txt | 1 +
3 files changed, 31 insertions(+), 5 deletions(-)
create mode 100644 docs/index.rst
diff --git a/docs/conf.py b/docs/conf.py
index b9fbdd8..ecf6c3a 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -12,13 +12,11 @@ version = ''
# -- General configuration
extensions = [
- # 'sphinx.ext.duration',
- # 'sphinx.ext.doctest',
- # 'sphinx.ext.autodoc',
- # 'sphinx.ext.autosummary',
- # 'sphinx.ext.intersphinx',
+ 'myst_parser'
]
+source_suffix = ['.rst', '.md']
+
# intersphinx_mapping = {
# 'python': ('https://docs.python.org/3/', None),
# 'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..4678e95
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,27 @@
+.. Sphinx with Markdown documentation master file, created by
+ sphinx-quickstart on Thu Oct 6 19:07:54 2016.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Batmen documentation
+================================================
+
+TODO
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+.. question.md
+.. answer.md
+.. answer_beni.md
+
+
+
+.. Indices and tables
+.. ==================
+
+.. * :ref:`genindex`
+.. * :ref:`modindex`
+.. * :ref:`search`
\ No newline at end of file
diff --git a/docs/requirements.txt b/docs/requirements.txt
index 5209692..10ba562 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -1,2 +1,3 @@
sphinx==7.2.6
sphinx_rtd_theme==1.3.0
+myst-parser==3.0.1
\ No newline at end of file
--
GitLab