From c886e8460b35406052f5433f94619e463f50f38c Mon Sep 17 00:00:00 2001 From: Russ Allbery Date: Mon, 19 Feb 2024 08:47:11 -0800 Subject: [PATCH] Fix minor documentation build issues Fix several redirects caught by a links check. Add new Pydantic noise to nitpick_ignore. --- CHANGELOG.md | 2 +- docs/documenteer.toml | 1 + docs/user-guide/set-up-from-template.rst | 4 ++-- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f286a352..84a77606 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -86,7 +86,7 @@ Changes for the upcoming release can be found in [changelog.d](https://github.co ### Other changes -- Safir now uses the [Ruff](https://beta.ruff.rs/docs/) linter instead of flake8 and isort. +- Safir now uses the [Ruff](https://docs.astral.sh/ruff/) linter instead of flake8 and isort. ## 4.3.1 (2023-07-17) diff --git a/docs/documenteer.toml b/docs/documenteer.toml index 4912a94f..f0fd5a79 100644 --- a/docs/documenteer.toml +++ b/docs/documenteer.toml @@ -19,6 +19,7 @@ nitpick_ignore_regex = [ nitpick_ignore = [ ['py:class', 'unittest.mock.Base'], ['py:class', 'unittest.mock.CallableMixin'], + ["py:obj", "ComputedFieldInfo"], ["py:obj", "JobMetadata.id"], ["py:class", "pydantic.BaseModel"], ["py:class", "BaseModel"], diff --git a/docs/user-guide/set-up-from-template.rst b/docs/user-guide/set-up-from-template.rst index 173f706c..e663241c 100644 --- a/docs/user-guide/set-up-from-template.rst +++ b/docs/user-guide/set-up-from-template.rst @@ -109,7 +109,7 @@ Now `create your application's repository on GitHub `__. +To set those credentials, follow GitHub's help page `Creating and storing encrypted secrets `__. The variables are: ``DOCKER_USERNAME`` @@ -117,7 +117,7 @@ The variables are: ``DOCKER_TOKEN`` A Docker Hub Personal Access Token associated with ``DOCKER_USERNAME``. - `Create a dedicated token `__ specifically for your project's GitHub Actions workflow. + `Create a dedicated token `__ specifically for your project's GitHub Actions workflow. After setting these secrets, re-run the GitHub Action by `re-running the workflow job from the GitHub Actions UI `__ or by pushing a new commit to GitHub.