a34efcac88
- Added docs folder with MkDocs and Sphinx integration for documentation. - Updated GitLab CI/CD configuration to include documentation jobs. - Improved Dockerfile for streamlined builds. - Added JavaScript file to support MathJax for equations in MkDocs. - Created and included a UML diagram for architectural overview. - Removed unused files to clean up the repository. - Updated project and package README files for consistency. - Revised diameter-dependent documentation for clarity. - Added detailed REST API documentation. - Updated project version for release tracking. - Included open-source acknowledgments in the documentation. - Added repository details and UI instructions to the user guide. - Integrated CO2 fitting algorithm into the project. - Included logo on the main documentation page and added CI/CD prod job.
34 lines
1.2 KiB
Python
34 lines
1.2 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# This file only contains a selection of the most common options. For a full
|
|
# list see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
# -- Path setup --------------------------------------------------------------
|
|
|
|
# If extensions (or modules to document with autodoc) are in another directory,
|
|
# add these directories to sys.path here. If the directory is relative to the
|
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
#
|
|
import os
|
|
import sys
|
|
sys.path.insert(0, os.path.abspath('../../src/caimira/calculator'))
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = 'CAiMIRA'
|
|
copyright = '2024, Andre Henriques et al.'
|
|
author = 'Andre Henriques et al.'
|
|
|
|
release = '1.0.0'
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
extensions = ['sphinx.ext.autodoc', 'sphinx_markdown_builder']
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
# This pattern also affects html_static_path and html_extra_path.
|
|
exclude_patterns = ['_build/*', 'Thumbs.db', '.DS_Store']
|
|
|
|
add_module_names = False
|