Skip to content

Commit

Permalink
Removed unused files and updated documentation for mkdocs (dockerfile…
Browse files Browse the repository at this point in the history
… included)
  • Loading branch information
lrdossan committed Nov 8, 2024
1 parent 0dc4c97 commit 81bf3eb
Show file tree
Hide file tree
Showing 33 changed files with 1,456 additions and 989 deletions.
41 changes: 41 additions & 0 deletions caimira/docs/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Use the conda image to install Python
FROM registry.cern.ch/docker.io/condaforge/mambaforge AS conda

ARG PYTHON_VERSION=3.12
RUN mamba create --yes -p /opt/app python=${PYTHON_VERSION}

# Install system dependencies, including Graphviz
RUN conda install conda-forge::graphviz

# Copy project files to the container
COPY . /app
WORKDIR /app

# Install caimira
RUN pip install .

# Docs directory
WORKDIR /app/docs

# Install docs dependencies
RUN pip install -r requirements.txt

# Sphinx directory
WORKDIR /app/docs/sphinx

# Generate markdown project's documentation
RUN sphinx-build -b markdown . _build/markdown

# Base docs directory
WORKDIR /app/docs

# Run the Python script to update markdown files, move it, and generate UML diagram
RUN python3 style_docs.py \
&& mv sphinx/_build/markdown/index.md mkdocs/docs/code_documentation/models.md \
&& pyreverse -o png -p UML-CAiMIRA --output-directory mkdocs/docs ../src/caimira/calculator/models/models.py

# Mkdocs directory
WORKDIR /app/docs/mkdocs

# Command to serve the MkDocs site
CMD ["python", "-m", "mkdocs", "serve", "--dev-addr=0.0.0.0:8080"]
3 changes: 3 additions & 0 deletions caimira/docs/mkdocs/docs/code_documentation/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Code Documentation

* [CAiMIRA models](models.md)
Original file line number Diff line number Diff line change
Expand Up @@ -310,9 +310,11 @@ Since the CO<sub>2</sub> concentration differs from the virus concentration, the

## CAiMIRA UML Diagram

The following diagram describes all the data classes and their relations under the `models.py` file. Click the diagram to zoom-in.
The following diagram describes all the data classes and their relations under the models.py file. Click the diagram to zoom-in.

[![CAiMIRA UML Diagram](UML-CAiMIRA.png)](UML-CAiMIRA.png)
[![CAiMIRA UML diagram](classes_UML-CAiMIRA.png)](UML-CAiMIRA.png)

CAiMIRA `models.py` file UML diagram.

## REFERENCES

Expand Down
Loading

0 comments on commit 81bf3eb

Please sign in to comment.