From 61b3e03b4608790805692bac6ffbbf0d77c3c6c6 Mon Sep 17 00:00:00 2001 From: wyrde Date: Sat, 6 May 2023 20:27:50 -0400 Subject: [PATCH] configurations --- .readthedocs.yaml | 9 +++++---- docs/conf.py | 20 ++++++++++++++++++++ docs/requirements.txt | 1 + 3 files changed, 26 insertions(+), 4 deletions(-) create mode 100644 docs/conf.py create mode 100644 docs/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 85492a7..ce437f2 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -16,12 +16,13 @@ build: # golang: "1.19" # Build documentation in the docs/ directory with Sphinx -#sphinx: -# configuration: docs/conf.py +sphinx: + configuration: docs/conf.py # If using Sphinx, optionally build your docs in additional formats such as PDF -# formats: -# - pdf +formats: + - pdf + - epub # Optionally declare the Python requirements required to build your docs #python: diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..c20e22e --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,20 @@ +# conf.py +# https://docs.readthedocs.io/en/stable/config-file/v2.html +# https://docs.readthedocs.io/en/stable/guides/migrate-rest-myst.html + + +extensions = [ + # Your existing extensions + ..., + "myst_parser", +] +myst_enable_extensions = [ + "amsmath", + "colon_fence", + "deflist", + "dollarmath", + "html_admonition", + "html_image", + "linkify", + "replacements", + "substitution"] diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..b84bfa4 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1 @@ +linkify-it-py