mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2025-04-19 00:45:22 +00:00
94467e1a69
* Add package API documentation generation Add generation of the API documentation for akkudoktoreos and akkudoktoreosserver packages. The API documentation is generated by the Sphinx autosummary extension. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com> * Enable Google style source commenting and documentation generation. Enable automatic documentation generation from Google style docstrings in the source. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com> * Check Google style source commenting. Check Google style commenting by the appropriate ruff rules. Commenting is _NOT_ enforced. Missing docstrings are ignored. Minor commenting quirks of the code base are adapted. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com> * Improve Markdown handling and switch to Markdown documentation. Switch to Markdown for the documentation files to improve the user and developer experience (see issue #181). Keep files with special directives for automatic API documentation in RST format. The directives expect RST. Also add dummy handling for openai/ swagger server documentation. The openai interface definition is for now taken from the fastapi PR as EOS will switch to fastAPI. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com> --------- Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com> Co-authored-by: Normann <github@koldrack.com>
92 lines
3.0 KiB
Makefile
92 lines
3.0 KiB
Makefile
# Define the targets
|
|
.PHONY: help venv pip install dist test test-full docker-run docs read-docs clean
|
|
|
|
# Default target
|
|
all: help
|
|
|
|
# Target to display help information
|
|
help:
|
|
@echo "Available targets:"
|
|
@echo " venv - Set up a Python 3 virtual environment."
|
|
@echo " pip - Install dependencies from requirements.txt."
|
|
@echo " pip-dev - Install dependencies from requirements-dev.txt."
|
|
@echo " install - Install EOS in editable form (development mode) into virtual environment."
|
|
@echo " docker-run - Run entire setup on docker"
|
|
@echo " docker-build - Rebuild docker image"
|
|
@echo " docs - Generate HTML documentation (in build/docs/html/)."
|
|
@echo " read-docs - Read HTML documentation in your browser."
|
|
@echo " run - Run flask_server in the virtual environment (needs install before)."
|
|
@echo " dist - Create distribution (in dist/)."
|
|
@echo " clean - Remove generated documentation, distribution and virtual environment."
|
|
|
|
# Target to set up a Python 3 virtual environment
|
|
venv:
|
|
python3 -m venv .venv
|
|
@echo "Virtual environment created in '.venv'. Activate it using 'source .venv/bin/activate'."
|
|
|
|
# Target to install dependencies from requirements.txt
|
|
pip: venv
|
|
.venv/bin/pip install --upgrade pip
|
|
.venv/bin/pip install -r requirements.txt
|
|
@echo "Dependencies installed from requirements.txt."
|
|
|
|
# Target to install dependencies from requirements.txt
|
|
pip-dev: pip
|
|
.venv/bin/pip install -r requirements-dev.txt
|
|
@echo "Dependencies installed from requirements-dev.txt."
|
|
|
|
# Target to install EOS in editable form (development mode) into virtual environment.
|
|
install: pip
|
|
.venv/bin/pip install build
|
|
.venv/bin/pip install -e .
|
|
@echo "EOS installed in editable form (development mode)."
|
|
|
|
# Target to create a distribution.
|
|
dist: pip
|
|
.venv/bin/pip install build
|
|
.venv/bin/python -m build --wheel
|
|
@echo "Distribution created (see dist/)."
|
|
|
|
# Target to generate HTML documentation
|
|
docs: pip-dev
|
|
.venv/bin/sphinx-build -M html docs build/docs
|
|
@echo "Documentation generated to build/docs/html/."
|
|
|
|
# Target to read the HTML documentation
|
|
read-docs: docs
|
|
@echo "Read the documentation in your browser"
|
|
.venv/bin/python -m webbrowser build/docs/html/index.html
|
|
|
|
# Clean target to remove generated documentation, distribution and virtual environment
|
|
clean:
|
|
@echo "Cleaning virtual env, distribution and build directories"
|
|
rm -rf dist build .venv
|
|
@echo "Searching and deleting all '_autosum' directories in docs..."
|
|
@find docs -type d -name '_autosummary' -exec rm -rf {} +;
|
|
@echo "Deletion complete."
|
|
|
|
run:
|
|
@echo "Starting flask server, please wait..."
|
|
.venv/bin/python -m akkudoktoreosserver.flask_server
|
|
|
|
# Target to setup tests.
|
|
test-setup: pip-dev
|
|
@echo "Setup tests"
|
|
|
|
# Target to run tests.
|
|
test:
|
|
@echo "Running tests..."
|
|
.venv/bin/pytest -vs --cov src --cov-report term-missing
|
|
|
|
# Target to run all tests.
|
|
test-full:
|
|
@echo "Running all tests..."
|
|
.venv/bin/pytest --full-run
|
|
|
|
# Run entire setup on docker
|
|
docker-run:
|
|
@docker compose up --remove-orphans
|
|
|
|
docker-build:
|
|
@docker compose build
|