Skip to content

Commit 0b53691

Browse files
committed
refactor: rename docs/doc-requirements.txt to docs/requirements.txt
1 parent 68a0331 commit 0b53691

File tree

5 files changed

+4
-16
lines changed

5 files changed

+4
-16
lines changed

.gitpod.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
tasks:
22
- init: |
33
pip3 install sphinx-autobuild
4-
pip3 install -r docs/doc-requirements.txt
4+
pip3 install -r docs/requirements.txt
55
pip3 install -e.
66
command: |
77
sphinx-autobuild docs/source/ docs/build/html/
File renamed without changes.

docs/source/contributing/contributing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ python3 -m venv .
126126
source bin/activate
127127
pip3 install -e .
128128
pip3 install -r dev-requirements.txt
129-
pip3 install -r docs/doc-requirements.txt
129+
pip3 install -r docs/requirements.txt
130130
pip3 install black
131131
```
132132

@@ -187,7 +187,7 @@ Then you are good to go!
187187
If you only changed the documentation, you can also build the documentation locally using `sphinx` .
188188

189189
```bash
190-
pip install -r docs/doc-requirements.txt
190+
pip install -r docs/requirements.txt
191191

192192
cd docs/
193193
make html

docs/source/contributing/tasks.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -155,18 +155,6 @@ release on the [GitHub repository releases page](https://github.com/jupyterhub/r
155155
That's it!
156156

157157

158-
## Keeping the Pipfile and requirements files up to date
159-
160-
We now have both a `dev-requirements.txt` and a `Pifile` for repo2docker, as
161-
such it is important to keep these in sync/up-to-date.
162-
163-
Both files use `pip identifiers` so if you are updating for example the Sphinx version
164-
in the `doc-requirements.txt` (currently `Sphinx = ">=1.4,!=1.5.4"`) you can use the
165-
same syntax to update the Pipfile and viceversa.
166-
167-
At the moment this has to be done manually so please make sure to update both
168-
files accordingly.
169-
170158
# Uncommon tasks
171159

172160
## Compare generated Dockerfiles between repo2docker versions

readthedocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ type: sphinx
33
python:
44
version: 3
55
setup_py_install: true
6-
requirements_file: docs/doc-requirements.txt
6+
requirements_file: docs/requirements.txt

0 commit comments

Comments
 (0)