Skip to content

Commit

Permalink
Merge pull request #237 from lsst-sqre/u/rra/docs-build
Browse files Browse the repository at this point in the history
Fix minor documentation build issues
  • Loading branch information
rra authored Feb 19, 2024
2 parents 9e23ee0 + 85da3ef commit d17be2a
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 4 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<a id='changelog-4.3.1'></a>
## 4.3.1 (2023-07-17)
Expand Down
5 changes: 4 additions & 1 deletion docs/documenteer.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"],
Expand All @@ -39,5 +40,7 @@ sqlalchemy = "https://docs.sqlalchemy.org/en/latest/"

[sphinx.linkcheck]
ignore = [
'^https://github\.com/lsst-sqre/safir/issues/new'
# StackOverflow sometimes rejects all link checks from GitHub Actions.
'^https://stackoverflow.com/questions/',
'^https://github\.com/lsst-sqre/safir/issues/new',
]
4 changes: 2 additions & 2 deletions docs/user-guide/set-up-from-template.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,15 +109,15 @@ Now `create your application's repository on GitHub <https://docs.github.com/en/
The first push to GitHub will fail.
That's because the Docker build step doesn't credentials for Docker Hub.

To set those credentials, follow GitHub's help page `Creating and storing encrypted secrets <https://docs.github.com/en/actions/security-guides/encrypted-secrets>`__.
To set those credentials, follow GitHub's help page `Creating and storing encrypted secrets <https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions>`__.
The variables are:

``DOCKER_USERNAME``
A Docker Hub username that has access to the lsstsqre organization on Docker Hub.

``DOCKER_TOKEN``
A Docker Hub Personal Access Token associated with ``DOCKER_USERNAME``.
`Create a dedicated token <https://docs.docker.com/docker-hub/access-tokens/>`__ specifically for your project's GitHub Actions workflow.
`Create a dedicated token <https://docs.docker.com/security/for-developers/access-tokens/>`__ 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 <https://docs.github.com/en/actions/managing-workflow-runs/re-running-workflows-and-jobs>`__ or by pushing a new commit to GitHub.

Expand Down

0 comments on commit d17be2a

Please sign in to comment.