From 0f34af6452f0980f355865a6c0f1de57c2ab5278 Mon Sep 17 00:00:00 2001 From: Miguel Xochicale Date: Thu, 22 Jun 2023 21:50:04 +0100 Subject: [PATCH] updates `adds .readthedocs.yaml and requirements-docs.txt and modifies tox.in and requirements-dev.txt (#115) --- .readthedocs.yaml | 23 +++++++++++++++++++++++ requirements-dev.txt | 2 -- requirements-docs.txt | 5 +++++ tox.ini | 1 + 4 files changed, 29 insertions(+), 2 deletions(-) create mode 100644 .readthedocs.yaml create mode 100644 requirements-docs.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..4fe1277 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,23 @@ +# .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-22.04 + tools: + python: "3.8" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + builder: html + configuration: docs/conf.py + fail_on_warning: false + +# Optionally declare the Python requirements required to build your docs +python: + install: + - requirements: requirements-docs.txt diff --git a/requirements-dev.txt b/requirements-dev.txt index 069ba91..d6d14cb 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -10,8 +10,6 @@ mock pyfakefs parameterized pylint<=2.17.0 -sphinx -sphinx_rtd_theme pyinstaller pytest tox diff --git a/requirements-docs.txt b/requirements-docs.txt new file mode 100644 index 0000000..f0be449 --- /dev/null +++ b/requirements-docs.txt @@ -0,0 +1,5 @@ +-r requirements.txt +six +docutils +sphinx +sphinx_rtd_theme \ No newline at end of file diff --git a/tox.ini b/tox.ini index 1404361..a93adf0 100644 --- a/tox.ini +++ b/tox.ini @@ -29,6 +29,7 @@ commands=pylint --rcfile=tests/pylintrc --extension-pkg-whitelist=PySide6,vtk,cv [testenv:docs] basepython=python3.8 changedir = doc +deps=-rrequirements-docs.txt commands = sphinx-build -M html . build [testenv:installer]