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

Fix broken references in documentation #10483

Merged
merged 2 commits into from
Sep 19, 2021
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,16 @@ on:
- cron: 0 0 * * MON # Run every Monday at 00:00 UTC

jobs:
docs:
name: docs
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
- run: pip install nox
- run: nox -s docs

determine-changes:
runs-on: ubuntu-latest
outputs:
Expand Down
2 changes: 2 additions & 0 deletions docs/html/reference/requirements-file-format.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
(requirements-file-format)=

# Requirements File Format

Requirements files serve as a list of items to be installed by pip, when
Expand Down
4 changes: 2 additions & 2 deletions docs/html/user_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ installed using :ref:`pip install` like so:

py -m pip install -r requirements.txt

Details on the format of the files are here: :ref:`Requirements File Format`.
Details on the format of the files are here: :ref:`requirements-file-format`.

Logically, a Requirements file is just a list of :ref:`pip install` arguments
placed in a file. Note that you should not rely on the items in the file being
Expand Down Expand Up @@ -185,7 +185,7 @@ not by discovering ``requirements.txt`` files embedded in projects.

See also:

* :ref:`Requirements File Format`
* :ref:`requirements-file-format`
* :ref:`pip freeze`
* `"setup.py vs requirements.txt" (an article by Donald Stufft)
<https://caremad.io/2013/07/setup-vs-requirement/>`_
Expand Down