-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Removed unused files and updated documentation for mkdocs (dockerfile…
… included)
- Loading branch information
Showing
33 changed files
with
1,456 additions
and
989 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Code Documentation | ||
|
||
* [CAiMIRA models](models.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.