diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..12a92ce6 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,30 @@ +# .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" + # You can also specify other tool versions: + nodejs: "16" + # rust: "1.55" + # golang: "1.17" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/source/conf.py + +# If using Sphinx, optionally build your docs in additional formats such as PDF +formats: + - pdf + - epub + +# Optionally declare the Python requirements required to build your docs +python: + install: + - requirements: docs/requirements.txt diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..1d5e0d5b --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +myst-parser>=0.17 +sphinxcontrib-mermaid>=0.7.1 diff --git a/docs/source/conf.py b/docs/source/conf.py index 9c42bc9b..a715c183 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -7,6 +7,8 @@ project = 'PGPainless' copyright = '2022, Paul Schaub' author = 'Paul Schaub' +master_doc = 'index' + # https://protips.readthedocs.io/git-tag-version.html latest_tag = os.popen('git describe --abbrev=0').read().strip() release = latest_tag