updated dockerfile

CERN · Nov 11, 2024 · 76c5918 · 76c5918
1 parent 3646c5d
commit 76c5918
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 19 deletions.
diff --git a/caimira/docs/Dockerfile b/caimira/docs/Dockerfile
@@ -11,14 +11,8 @@ RUN conda install conda-forge::graphviz
 COPY . /app
 WORKDIR /app
 
-# Install caimira
-RUN pip install .
-
-# Docs directory
-WORKDIR /app/docs
-
-# Install docs dependencies
-RUN pip install -r requirements.txt
+# Install CAiMIRA docs
+RUN pip install .[doc]
 
 # Sphinx directory
 WORKDIR /app/docs/sphinx

diff --git a/caimira/docs/mkdocs/docs/code_documentation/index.md b/caimira/docs/mkdocs/docs/code_documentation/index.md
diff --git a/caimira/docs/mkdocs/docs/code_documentation/index.md.md b/caimira/docs/mkdocs/docs/code_documentation/index.md.md
@@ -0,0 +1,4 @@
+# Code-related Documentation
+
+* [CAiMIRA REST API](rest_api.md)
+* [CAiMIRA models](models.md)
diff --git a/caimira/docs/mkdocs/mkdocs.yml b/caimira/docs/mkdocs/mkdocs.yml
@@ -4,8 +4,11 @@ theme:
 
 nav:
   - Home: index.md
+  - Project README: project_README.md
   - Diameter-dependent model: full_diameter_dependence.md
-  - Code documentation: code_documentation/index.md
+  - Code-related documentation:
+      - CAiMIRA REST API: code_documentation/rest_api.md
+      - CAiMIRA models: code_documentation/models.md
 
 markdown_extensions:
   - pymdownx.arithmatex:

diff --git a/caimira/docs/requirements.txt b/caimira/docs/requirements.txt
diff --git a/caimira/docs/style_docs.py b/caimira/docs/style_docs.py
@@ -50,4 +50,5 @@ def main():
         print(f"File '{md_file_path}' does not exist, skipping update.")
 
 if __name__ == "__main__":
-    main()
+    main()
+
diff --git a/caimira/pyproject.toml b/caimira/pyproject.toml
@@ -49,7 +49,10 @@ test = [
 ]
 doc = [
     "sphinx",
-    "sphinx_rtd_theme"
+    "sphinx_markdown_builder",
+    "pylint",
+    "mkdocs",
+    "mkdocs-material",
 ]
 
 [project.urls]