bugfixes

iAMB-RWTH-Aachen · Dec 16, 2024 · aa87658 · aa87658
1 parent dd14da7
commit aa87658
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 2 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -18,6 +18,7 @@ build:
 # Build documentation in the "docs/" directory with Sphinx
 sphinx:
   configuration: docs/conf.py
+  source: docs/docs
 
 # Optionally build your docs in additional formats such as PDF and ePub
 # formats:

diff --git a/docs/conf.py b/docs/conf.py
@@ -2,7 +2,7 @@
 
 # -- Project information
 
-project = 'Lumache'
+project = 'PAModelpy'
 copyright = '2024, iAMB, RWTH Aachen University'
 author = 'Samira van den Bogaard'
 
@@ -17,6 +17,7 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
     'sphinx.ext.intersphinx',
+    'myst_parser',  # Add this for Markdown support
 ]
 
 intersphinx_mapping = {
@@ -32,4 +33,12 @@
 html_theme = 'sphinx_rtd_theme'
 
 # -- Options for EPUB output
-epub_show_urls = 'footnote'
+epub_show_urls = 'footnote'
+
+# Enable specific MyST features
+myst_enable_extensions = [
+    "colon_fence",  # Support for ::: directives
+    "deflist",      # Support for definition lists
+    "html_admonition",  # HTML-style admonitions
+    "html_image",   # Use HTML-style <img> tags
+]
diff --git a/docs/index.rst b/docs/index.rst
@@ -0,0 +1,14 @@
+Welcome to PAModelpy
+===
+
+The PAModelpy package is designed to integrate protein constraints and protein sectors into protein allocation models (PAMs).
+In this documentation, you can find all the information you need to get build and analyze PAMs.
+
+Table of Contents
+===
+.. toctree::
+   :glob:
+   :maxdepth: 2
+   :caption: Table of Contents
+
+   *.md