From 126a033d2c330097304eabd89d9cffd7abdaf465 Mon Sep 17 00:00:00 2001 From: lrdossan Date: Mon, 11 Nov 2024 10:35:39 +0000 Subject: [PATCH] updated dockerfile --- caimira/docs/Dockerfile | 10 ++-------- caimira/docs/mkdocs/docs/code_documentation/index.md | 3 --- caimira/docs/mkdocs/mkdocs.yml | 5 ++++- caimira/docs/requirements.txt | 5 ----- caimira/docs/style_docs.py | 3 ++- caimira/pyproject.toml | 5 ++++- 6 files changed, 12 insertions(+), 19 deletions(-) delete mode 100644 caimira/docs/mkdocs/docs/code_documentation/index.md delete mode 100644 caimira/docs/requirements.txt diff --git a/caimira/docs/Dockerfile b/caimira/docs/Dockerfile index 0596f5ae..22055d85 100644 --- 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 deleted file mode 100644 index cfa3d7da..00000000 --- a/caimira/docs/mkdocs/docs/code_documentation/index.md +++ /dev/null @@ -1,3 +0,0 @@ -# Code Documentation - -* [CAiMIRA models](models.md) diff --git a/caimira/docs/mkdocs/mkdocs.yml b/caimira/docs/mkdocs/mkdocs.yml index 6c082b01..24a3a568 100644 --- 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 deleted file mode 100644 index a12f55d9..00000000 --- a/caimira/docs/requirements.txt +++ /dev/null @@ -1,5 +0,0 @@ -sphinx==6.2.1 -sphinx_markdown_builder==0.6.7 -pylint==3.3.1 -mkdocs==1.6.1 -mkdocs-material==9.5.41 \ No newline at end of file diff --git a/caimira/docs/style_docs.py b/caimira/docs/style_docs.py index e17949df..e48970ab 100644 --- 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() \ No newline at end of file + main() + \ No newline at end of file diff --git a/caimira/pyproject.toml b/caimira/pyproject.toml index 9f82c5d5..64f56d76 100644 --- 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]