From 5b775619881140b0b749f962baaaa2ba106c89c4 Mon Sep 17 00:00:00 2001 From: sppopovic Date: Fri, 20 Sep 2024 09:49:44 +0200 Subject: [PATCH] Added some more files for MkDocs --- .readthedocs.yaml | 28 ++++++++-------------------- mkdocs.yml | 16 ++++++++++++++++ 2 files changed, 24 insertions(+), 20 deletions(-) create mode 100644 mkdocs.yml diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 92a3a63..ab51417 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -5,28 +5,16 @@ # Required 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: - os: ubuntu-22.04 + os: ubuntu-24.04 tools: 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 -sphinx: - configuration: docs/conf.py +mkdocs: + configuration: mkdocs.yml -# Optionally build your docs in additional formats such as PDF and ePub -# formats: -# - pdf -# - epub - -# 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 \ No newline at end of file +# Optionally declare the Python requirements required to build your docs +#python: +# install: +# - requirements: docs/requirements.txt diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..c5388be --- /dev/null +++ b/mkdocs.yml @@ -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