From e483caa298d5aafcca17d2c7038136696af6e4ce Mon Sep 17 00:00:00 2001 From: Erik Sundell Date: Sat, 26 Nov 2022 12:06:16 +0100 Subject: [PATCH 1/2] docs: stick with docs/requirements.txt Based on a discussion in jupyterhub/jupyterhub, I want to revert a switch to use a doc target in extras_require and stick with having a docs/requirements.txt file here like in jupyterhub/jupyterhub. --- .readthedocs.yaml | 3 +-- CONTRIBUTING.md | 2 +- docs/requirements.txt | 12 ++++++++++++ pyproject.toml | 6 ------ 4 files changed, 14 insertions(+), 9 deletions(-) create mode 100644 docs/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml index fff56ac1..08526cc6 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -14,5 +14,4 @@ build: python: install: - - method: pip - path: ".[doc]" + - requirements: docs/requirements.txt diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 61c6fb90..803bd35f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -48,7 +48,7 @@ walk you through the process of proposing your change ("making a Pull Request"). A brief guide to setting up for local development ```sh -pip install -e ".[doc]" +pip install -r docs/requirements.txt cd docs make html diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..fb953050 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,12 @@ +# This requirements.txt file must be installed from the projects root folder: +# +# pip install -r docs/requirements.txt +# +# Install the package to help autodoc-traits inspect and generate documentation. +# +--editable . + +autodoc-traits +myst-parser>=0.17.0 +sphinx-book-theme +sphinx-copybutton diff --git a/pyproject.toml b/pyproject.toml index 24c09f1b..fe195ce5 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -39,12 +39,6 @@ dependencies = [ dynamic = ["version"] [project.optional-dependencies] -doc = [ - "autodoc_traits", - "myst-parser>=0.17.0", - "sphinx-book-theme", - "sphinx-copybutton", -] test = [ "kubernetes>=11", "pytest>=5.4", From ff04c2bed2fbf7d1fba6f49db563d99d845c90d2 Mon Sep 17 00:00:00 2001 From: Erik Sundell Date: Sat, 26 Nov 2022 17:15:22 +0100 Subject: [PATCH 2/2] Fix typo in a comment Co-authored-by: Simon Li --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index fb953050..ca40926a 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -# This requirements.txt file must be installed from the projects root folder: +# This requirements.txt file must be installed from the project's root folder: # # pip install -r docs/requirements.txt #