docs: Move to poetry

named-data · May 27, 2023 · fbc5359 · fbc5359
1 parent 4dd0c50
commit fbc5359
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 46 deletions.
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -64,7 +64,7 @@
 	// Use 'forwardPorts' to make a list of ports inside the container available locally.
 	// "forwardPorts": [],
 	// Use 'postCreateCommand' to run commands after the container is created.
-	"postCreateCommand": "pip3 install --force-reinstall -e .[dev]",
+	"postCreateCommand": "pip3 install --force-reinstall -e .[dev,docs]",
 	// Uncomment to connect as a non-root user. See https://aka.ms/vscode-remote/containers/non-root.
 	"remoteUser": "vscode"
 }
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -17,11 +17,14 @@ sphinx:
 formats: all
 
 build:
-  os: ubuntu-20.04
+  os: ubuntu-22.04
   tools:
-    python: "3.10"
+    python: "3.11"
 
 # Optionally set the version of Python and requirements required to build your docs
 python:
   install:
-    - requirements: docs/requirements.txt
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
diff --git a/docs/requirements.txt b/docs/requirements.txt
diff --git a/docs/src/installation.rst b/docs/src/installation.rst
@@ -19,15 +19,15 @@ For development, `poetry <https://python-poetry.org/>`_ is recommended. You need
 
 And to install the development environment::
 
-    $ poetry install --all-extras --with docs
+    $ poetry install --all-extras
 
 To setup a traditional python3 virtual environment with editable installation:
 
 .. code-block:: bash
 
     python3 -m venv venv
     . venv/bin/activate
-    pip3 install -e ".[dev]"
+    pip3 install -e ".[dev,docs]"
 
 Run all tests:
 

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -53,16 +53,14 @@ pytest = { version = "^7.1.2", optional = true }
 pytest-cov = { version = "^3.0.0", optional = true }
 flake8 = { version = "^4.0.1", optional = true }
 
+# Extra dependencies [docs]
+Sphinx = { version = "^6.2.1", optional = true }
+sphinx-rtd-theme = { version = "^1.2.1", optional = true }
+sphinx-autodoc-typehints = { version = "^1.23.0", optional = true }
+
 [tool.poetry.extras]
 dev = ["pytest", "pytest-cov", "flake8"]
-
-[tool.poetry.group.docs]
-optional = true
-
-[tool.poetry.group.docs.dependencies]
-Sphinx = "^6.2.1"
-sphinx-rtd-theme = "^1.2.1"
-sphinx-autodoc-typehints = "^1.23.0"
+docs = ["Sphinx", "sphinx-rtd-theme", "sphinx-autodoc-typehints"]
 
 [tool.poetry.scripts]
 pyndnsec = "ndn.bin.sec:main"