From 992d954ebdea91a797a81c2c1ab17cdaf7de7903 Mon Sep 17 00:00:00 2001 From: Pradyun Gedam Date: Sat, 18 Sep 2021 09:11:42 +0100 Subject: [PATCH 1/2] Fix broken references in documentation --- docs/html/reference/requirements-file-format.md | 2 ++ docs/html/user_guide.rst | 4 ++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/html/reference/requirements-file-format.md b/docs/html/reference/requirements-file-format.md index 3ee708e1abb..d05f1acca10 100644 --- a/docs/html/reference/requirements-file-format.md +++ b/docs/html/reference/requirements-file-format.md @@ -1,3 +1,5 @@ +(requirements-file-format)= + # Requirements File Format Requirements files serve as a list of items to be installed by pip, when diff --git a/docs/html/user_guide.rst b/docs/html/user_guide.rst index 2d059709271..059fd7cdc35 100644 --- a/docs/html/user_guide.rst +++ b/docs/html/user_guide.rst @@ -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 @@ -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) `_ From 035bc846823d3f87f1bc0d236d60a4b7838cfde6 Mon Sep 17 00:00:00 2001 From: Pradyun Gedam Date: Sat, 18 Sep 2021 09:12:45 +0100 Subject: [PATCH 2/2] Add CI job to ensure that the documentation builds without warnings This will help with issues that are being flagged as warnings by Sphinx. --- .github/workflows/ci.yml | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 1f3e41746d9..51f7b8f9bbb 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -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: