diff --git a/.gitignore b/.gitignore index 91482e6..aedabd9 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,8 @@ dist/* chart/* *.yaml *.yml +!mkdocs.yaml +!.readthedocs.yaml ./katenary *.env docker-compose* diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..4329a52 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,20 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the version of Python and other tools you might need +build: + os: ubuntu-20.04 + tools: + python: "3.9" + +mkdocs: + configuration: doc/mkdocs.yml + +# Optionally declare the Python requirements required to build your docs +python: + install: + - requirements: doc/requirements.txt diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000..39a222d --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,2 @@ +mkdocs==1.3.0 +Jinja2==2.10.2