diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..b59df2a5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +_build +*~ diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..a4e474fe --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,35 @@ +# Read the Docs configuration file for Sphinx projects +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.12" + # You can also specify other tool versions: + # nodejs: "20" + # rust: "1.70" + # golang: "1.20" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: ./conf.py + # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs + # builder: "dirhtml" + # Fail on all warnings to avoid broken references + # fail_on_warning: true + +# 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: requirements.txt diff --git a/_static/custom.css b/_static/custom.css new file mode 100644 index 00000000..8e2b363b --- /dev/null +++ b/_static/custom.css @@ -0,0 +1,39 @@ +.rst-content code.literal { + color: inherit; + font-size: 85%; + border: none; + background: #E8E8E8; + padding: 2px 3px; + border-radius: .33em; +} + +.toctree-l1 > ul { + margin-top: 3px ! important; +} + +.toctree-l2 > ul { + margin-top: 0 ! important; + margin-bottom: 3px ! important; +} + +ul.simple > li { + margin-bottom: 10px; +} + +div.tight > ul.simple > li { + margin-bottom: 0; +} + +kbd { + display: inline-block; + padding: 3px 5px ! important; + font-size: 80% ! important; + line-height: 10px ! important; + color: #444d56 ! important; + vertical-align: middle ! important; + background-color: #fafbfc ! important; + border: solid 1.5px #c6cbd1 ! important; + border-bottom-color: #959da5 ! important; + border-radius: 3px ! important; + box-shadow: inset -.5px -1px 0 #959da5 ! important; +} diff --git a/_templates/sourcelink.html b/_templates/sourcelink.html deleted file mode 100644 index 4f1ef064..00000000 --- a/_templates/sourcelink.html +++ /dev/null @@ -1,9 +0,0 @@ -{%- if show_source and has_source and sourcename %} -
t |