From 1bb5960d800c852a049cfaeffeec81ebc7014d28 Mon Sep 17 00:00:00 2001 From: Miguel Xochicale Date: Wed, 10 May 2023 12:13:37 +0100 Subject: [PATCH] adds .readthedocs.yaml; docs/requirements.txt and updates requirements-dev.txt and docs/.gitignore (#216) --- .readthedocs.yaml | 21 +++++++++++++++++++++ docs/.gitignore | 2 +- docs/requirements.txt | 4 ++++ requirements-dev.txt | 6 +----- 4 files changed, 27 insertions(+), 6 deletions(-) create mode 100644 .readthedocs.yaml create mode 100644 docs/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..5545308c --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,21 @@ +# .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: + configuration: docs/conf.py + +# Optionally declare the Python requirements required to build your docs +python: + install: + - requirements: docs/requirements.txt \ No newline at end of file diff --git a/docs/.gitignore b/docs/.gitignore index 8d42aa1e..76632882 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,4 +1,4 @@ /sksurgeryvtk.rst /sksurgeryvtk.*.rst /modules.rst -/build +/build \ No newline at end of file diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..52eaf35d --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,4 @@ +six<=1.16.0 +sphinx<=5.3.0 +sphinx_rtd_theme<=1.2.0 +nbsphinx<=0.8.12 \ No newline at end of file diff --git a/requirements-dev.txt b/requirements-dev.txt index a0ab7f02..0d8f7cda 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -9,14 +9,10 @@ mock<=5.0.1 pyfakefs<=5.1.0 parameterized<=0.8.1 pylint<=2.16.1 -sphinx<=5.3.0 -sphinx_rtd_theme<=1.2.0 -nbsphinx<=0.8.12 pyinstaller<=5.7.0 pytest<=7.2.1 pytest-qt-app<=1.0.1 pytest-qt<=4.2.0 tox<=4.4.5 coveralls<=3.3.1 -pyyaml<=6.0 -six<=1.16.0 \ No newline at end of file +pyyaml<=6.0 \ No newline at end of file