Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: stick with docs/requirements.txt #683

Merged
merged 2 commits into from Nov 28, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 1 addition & 2 deletions .readthedocs.yaml
Expand Up @@ -14,5 +14,4 @@ build:

python:
install:
- method: pip
path: ".[doc]"
- requirements: docs/requirements.txt
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Expand Up @@ -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
Expand Down
12 changes: 12 additions & 0 deletions docs/requirements.txt
@@ -0,0 +1,12 @@
# This requirements.txt file must be installed from the project's 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
6 changes: 0 additions & 6 deletions pyproject.toml
Expand Up @@ -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",
Expand Down