diff --git a/.github/workflows/slow-checks.yml b/.github/workflows/slow-checks.yml index 895efe30f..648c845b7 100644 --- a/.github/workflows/slow-checks.yml +++ b/.github/workflows/slow-checks.yml @@ -20,6 +20,7 @@ jobs: permissions: contents: read env: + # Required for integration tests that call the GitHub CLI. GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} strategy: fail-fast: false diff --git a/doc/changes/unreleased.md b/doc/changes/unreleased.md index 8292212a9..b7c8196e1 100644 --- a/doc/changes/unreleased.md +++ b/doc/changes/unreleased.md @@ -2,6 +2,12 @@ ## Summary +This release documents how to discover and use PTB's Nox sessions in the user +guide and removes the unused Modules section from the developer guide. + +## Documentation + +* #456: Documented how to discover PTB nox sessions in the user guide and removed the unused developer-guide Modules section ## Bug * #909: Updated `cd.yml` workflow so that `cd-extension.yml` workflow depends on `build-and-publish`. This ensures that the custom release workflow only runs when the PyPi release was successful. diff --git a/doc/developer_guide/developer_guide.rst b/doc/developer_guide/developer_guide.rst index cc9224315..03037fd33 100644 --- a/doc/developer_guide/developer_guide.rst +++ b/doc/developer_guide/developer_guide.rst @@ -9,4 +9,3 @@ ../design plugins - modules/modules diff --git a/doc/developer_guide/modules/modules.rst b/doc/developer_guide/modules/modules.rst deleted file mode 100644 index 21c47bf28..000000000 --- a/doc/developer_guide/modules/modules.rst +++ /dev/null @@ -1,7 +0,0 @@ -Modules -======= - -.. toctree:: - :maxdepth: 2 - - nox_tasks diff --git a/doc/developer_guide/modules/nox_tasks.rst b/doc/developer_guide/modules/nox_tasks.rst deleted file mode 100644 index b930c8d75..000000000 --- a/doc/developer_guide/modules/nox_tasks.rst +++ /dev/null @@ -1,14 +0,0 @@ -nox_tasks -========= - -lint:import (experimental) -__________________________ - -`Import Linter `_ -allows you to define and enforce rules for the imports within and between Python packages. - -.. important:: - - First configure the linter in file :code:`.import_linter_config`, see - `import-linter top-level-configuration `_ - and `import-linter contract types `_ diff --git a/doc/user_guide/features/index.rst b/doc/user_guide/features/index.rst index 373fb643b..8f66605b4 100644 --- a/doc/user_guide/features/index.rst +++ b/doc/user_guide/features/index.rst @@ -37,3 +37,17 @@ Important Nox Commands * :code:`nox -l` shows a list of all available nox sessions * :code:`nox -s ` run the specified session(s) + +The command :code:`nox -l` is the most reliable way to see the full current +session list for your project. + +Common examples are: + +* :code:`nox -s format:fix` to apply formatting changes +* :code:`nox -s project:check` to run the main local quality gate +* :code:`nox -s test:unit` to run unit tests +* :code:`nox -s workflow:generate -- all` to regenerate PTB workflows + +Use the feature pages in this guide for task-specific details, for example +formatting, GitHub workflows, dependency management, release preparation, and +code-quality reporting.