From 24951cee274c70cdf999468c8c12c5e0eab7234d Mon Sep 17 00:00:00 2001 From: Segev BenZvi Date: Fri, 2 Feb 2024 16:57:24 -0500 Subject: [PATCH 1/5] Add default language. --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 572e720..2e8a87b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -75,7 +75,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = 'en' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. From 520c9d3e8156243fedb7d400616c5dfdfc118fb1 Mon Sep 17 00:00:00 2001 From: Segev BenZvi Date: Fri, 2 Feb 2024 16:57:36 -0500 Subject: [PATCH 2/5] Add documentation-specific requirements. --- docs/requirements.txt | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 docs/requirements.txt diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..4fd7755 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,28 @@ +# Required packages +# +click~=8.1 +hop-client~=0.8.0 +inquirer~=2.8 +ipython~=8.7 +numpy~=1.26 +python-dotenv~=0.19 +setuptools~=69.0 +wheel~=0.42 +# +# Development packages +# +virtualenv~=20.13 +pytest~=8.0 +pytest-console-scripts~=1.4 +pytest-cov~=4.1 +pytest-mongodb~=2.4 +pytest-runner~=6.0 +# +# Documentation packages +# +autoapi~=2.0.1 +myst-parser~=2.0 +sphinx~=7.2 +sphinx-autoapi~=3.0 +sphinx_rtd_theme~=2.0 +sphinxcontrib-programoutput~=0.17 From c053840d55485a915bceb741aabd2a1b25aaa531 Mon Sep 17 00:00:00 2001 From: Segev BenZvi Date: Fri, 2 Feb 2024 16:58:05 -0500 Subject: [PATCH 3/5] Point to documentation requirements. --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 7d710eb..cf7e763 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -11,4 +11,4 @@ sphinx: python: install: - - requirements: requirements.txt + - requirements: doc/requirements.txt From 8832e2f980bccf9f766fe7d42439c42b446fdeb6 Mon Sep 17 00:00:00 2001 From: Segev BenZvi Date: Fri, 2 Feb 2024 17:06:34 -0500 Subject: [PATCH 4/5] Modernize readthedocs version. --- .readthedocs.yaml | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index cf7e763..b2b7a09 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,14 +1,22 @@ +# .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 OS, Python version and other tools you might need build: - os: "ubuntu-20.04" - tools: - python: "3.9" + os: ubuntu-22.04 + tools: + python: "3.12" +# Build documentation in the "doc/" directory with Sphinx sphinx: - configuration: docs/conf.py + configuration: doc/conf.py +# Python requirements required to build documentation. +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html python: - install: - - requirements: doc/requirements.txt + install: + - requirements: doc/requirements.txt From c3a1aab7b49d8d4ae2ff65b052d409b0087b3367 Mon Sep 17 00:00:00 2001 From: Segev BenZvi Date: Fri, 2 Feb 2024 17:11:35 -0500 Subject: [PATCH 5/5] Fix stupid typo in YAML file. --- .readthedocs.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index b2b7a09..20e1803 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -11,12 +11,12 @@ build: tools: python: "3.12" -# Build documentation in the "doc/" directory with Sphinx +# Build documentation in the "docs/" directory with Sphinx sphinx: - configuration: doc/conf.py + configuration: docs/conf.py # Python requirements required to build documentation. # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html python: install: - - requirements: doc/requirements.txt + - requirements: docs/requirements.txt