From 066b16d7b6f6d503267a1deaf10fa740993dab6b Mon Sep 17 00:00:00 2001 From: Phil Schaf Date: Thu, 9 Jan 2025 10:51:27 +0100 Subject: [PATCH 1/2] Mention towncrier in contribution docs --- docs/dev/code.md | 1 + docs/dev/documentation.md | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/dev/code.md b/docs/dev/code.md index 1e9d295725..f8119f9870 100644 --- a/docs/dev/code.md +++ b/docs/dev/code.md @@ -9,6 +9,7 @@ 5. {ref}`Make sure all tests are passing ` 6. {ref}`Build and visually check any changed documentation ` 7. {ref}`Open a PR back to the main repository ` +8. {ref}`Add a release note to your PR ` (and, if applicable, other documentation) ## Code style diff --git a/docs/dev/documentation.md b/docs/dev/documentation.md index d9c3f6e034..f02515bc86 100644 --- a/docs/dev/documentation.md +++ b/docs/dev/documentation.md @@ -12,10 +12,11 @@ Sometimes these caches are not invalidated when you've updated the docs. If docs are not updating the way you expect, first try "force reloading" your browser page – e.g. reload the page without using the cache. Next, if problems persist, clear the sphinx cache (`hatch run docs:clean`) and try building them again. +(adding-to-the-docs)= + ## Adding to the docs For any user-visible changes, please make sure a note has been added to the release notes using [`hatch run towncrier:create`][towncrier create]. -We recommend waiting on this until your PR is close to done since this can often causes merge conflicts. Once you've added a new function to the documentation, you'll need to make sure there is a link somewhere in the documentation site pointing to it. This should be added to `docs/api.md` under a relevant heading. From 3ea1d351dff9bc070268faab37bf9e832c81532f Mon Sep 17 00:00:00 2001 From: Phil Schaf Date: Thu, 9 Jan 2025 15:38:34 +0100 Subject: [PATCH 2/2] note discrepancy --- docs/dev/code.md | 2 +- docs/dev/documentation.md | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/dev/code.md b/docs/dev/code.md index f8119f9870..3ca393c8f7 100644 --- a/docs/dev/code.md +++ b/docs/dev/code.md @@ -9,7 +9,7 @@ 5. {ref}`Make sure all tests are passing ` 6. {ref}`Build and visually check any changed documentation ` 7. {ref}`Open a PR back to the main repository ` -8. {ref}`Add a release note to your PR ` (and, if applicable, other documentation) +8. {ref}`Add a release note to your PR ` ## Code style diff --git a/docs/dev/documentation.md b/docs/dev/documentation.md index f02515bc86..dcad9533ed 100644 --- a/docs/dev/documentation.md +++ b/docs/dev/documentation.md @@ -17,6 +17,7 @@ Next, if problems persist, clear the sphinx cache (`hatch run docs:clean`) and t ## Adding to the docs For any user-visible changes, please make sure a note has been added to the release notes using [`hatch run towncrier:create`][towncrier create]. +When asked for “Issue number (`+` if none)”, enter the *PR number* instead. Once you've added a new function to the documentation, you'll need to make sure there is a link somewhere in the documentation site pointing to it. This should be added to `docs/api.md` under a relevant heading.