diff --git a/.gitpod.yml b/.gitpod.yml index f8963640..157da39e 100644 --- a/.gitpod.yml +++ b/.gitpod.yml @@ -1,7 +1,7 @@ tasks: - init: | pip3 install sphinx-autobuild - pip3 install -r docs/doc-requirements.txt + pip3 install -r docs/requirements.txt pip3 install -e. command: | sphinx-autobuild docs/source/ docs/build/html/ diff --git a/docs/doc-requirements.txt b/docs/requirements.txt similarity index 100% rename from docs/doc-requirements.txt rename to docs/requirements.txt diff --git a/docs/source/contributing/contributing.md b/docs/source/contributing/contributing.md index 96859a6b..98075dd7 100644 --- a/docs/source/contributing/contributing.md +++ b/docs/source/contributing/contributing.md @@ -126,7 +126,7 @@ python3 -m venv . source bin/activate pip3 install -e . pip3 install -r dev-requirements.txt -pip3 install -r docs/doc-requirements.txt +pip3 install -r docs/requirements.txt pip3 install black ``` @@ -187,7 +187,7 @@ Then you are good to go! If you only changed the documentation, you can also build the documentation locally using `sphinx` . ```bash -pip install -r docs/doc-requirements.txt +pip install -r docs/requirements.txt cd docs/ make html diff --git a/docs/source/contributing/tasks.md b/docs/source/contributing/tasks.md index b6602e0d..3fe47585 100644 --- a/docs/source/contributing/tasks.md +++ b/docs/source/contributing/tasks.md @@ -155,18 +155,6 @@ release on the [GitHub repository releases page](https://github.com/jupyterhub/r That's it! -## Keeping the Pipfile and requirements files up to date - -We now have both a `dev-requirements.txt` and a `Pifile` for repo2docker, as -such it is important to keep these in sync/up-to-date. - -Both files use `pip identifiers` so if you are updating for example the Sphinx version -in the `doc-requirements.txt` (currently `Sphinx = ">=1.4,!=1.5.4"`) you can use the -same syntax to update the Pipfile and viceversa. - -At the moment this has to be done manually so please make sure to update both -files accordingly. - # Uncommon tasks ## Compare generated Dockerfiles between repo2docker versions diff --git a/readthedocs.yml b/readthedocs.yml index 4fae81d6..4409431e 100644 --- a/readthedocs.yml +++ b/readthedocs.yml @@ -3,4 +3,4 @@ type: sphinx python: version: 3 setup_py_install: true -requirements_file: docs/doc-requirements.txt +requirements_file: docs/requirements.txt