Merge pull request hrcorval#161 from hrcorval/release_4.0.7

Fixing documentation issue
iamkenos · Oct 8, 2024 · 0da5f17 · 0da5f17
2 parents 413c2ec + a57b735
commit 0da5f17
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 7 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1 @@
+```{include} ../README.md
diff --git a/docs/conf.py b/docs/conf.py
@@ -2,7 +2,7 @@
 
 # -- Project information -----------------------------------------------------
 project = 'BehaveX'
-copyright = '2024, hrcorval'
+copyright = '2023, hrcorval'
 author = 'hrcorval'
 
 # -- General configuration ---------------------------------------------------
@@ -16,7 +16,10 @@
 master_doc = 'index'
 
 # The suffix(es) of source filenames.
-source_suffix = ['.rst', '.md']
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.md': 'markdown',
+}
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,13 +1,12 @@
 Welcome to BehaveX's documentation!
 ===================================
 
-.. include:: ../README.md
-   :parser: myst_parser
-
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
+   readme
+
 Indices and tables
 ==================
 

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,3 +1,3 @@
-myst-parser
-sphinx
+myst-parser>=0.15
+sphinx>=4.0
 sphinx_rtd_theme