Added some more files for MkDocs

This commit is contained in:
sppopovic 2024-09-20 09:49:44 +02:00
parent 60ee59d59b
commit 5b77561988
2 changed files with 24 additions and 20 deletions

View file

@ -5,28 +5,16 @@
# Required # Required
version: 2 version: 2
# Set the OS, Python version and other tools you might need # Set the version of Python and other tools you might need
build: build:
os: ubuntu-22.04 os: ubuntu-24.04
tools: tools:
python: "3.12" python: "3.12"
# You can also specify other tool versions:
# nodejs: "19"
# rust: "1.64"
# golang: "1.19"
# Build documentation in the "docs/" directory with Sphinx mkdocs:
sphinx: configuration: mkdocs.yml
configuration: docs/conf.py
# Optionally build your docs in additional formats such as PDF and ePub # Optionally declare the Python requirements required to build your docs
# formats: #python:
# - pdf # install:
# - epub # - requirements: docs/requirements.txt
# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
# python:
# install:
# - requirements: docs/requirements.txt

16
mkdocs.yml Normal file
View file

@ -0,0 +1,16 @@
site_name: O-ESD
theme:
name: readthedocs
highlightjs: true
plugins:
- search
- mkdocstrings:
handlers:
# See: https://mkdocstrings.github.io/python/usage/
python:
options:
docstring_style: sphinx
markdown_extensions:
- markdown_include.include:
base_path: .
- admonition