diff --git a/.github/workflows/build-and-publish.yml b/.github/workflows/build-and-publish.yml
index 4813cc73b..f42d877ee 100644
--- a/.github/workflows/build-and-publish.yml
+++ b/.github/workflows/build-and-publish.yml
@@ -23,7 +23,7 @@ jobs:
- name: Set up Python & Poetry Environment
id: set-up-python-and-poetry-environment
- uses: exasol/python-toolbox/.github/actions/python-environment@v9
+ uses: exasol/python-toolbox/.github/actions/python-environment@v10
with:
python-version: "3.10"
poetry-version: "2.3.0"
diff --git a/.github/workflows/check-release-tag.yml b/.github/workflows/check-release-tag.yml
index 2191c3057..0e3971ab1 100644
--- a/.github/workflows/check-release-tag.yml
+++ b/.github/workflows/check-release-tag.yml
@@ -21,7 +21,7 @@ jobs:
- name: Set up Python & Poetry Environment
id: set-up-python-and-poetry-environment
- uses: exasol/python-toolbox/.github/actions/python-environment@v9
+ uses: exasol/python-toolbox/.github/actions/python-environment@v10
with:
python-version: "3.10"
poetry-version: "2.3.0"
diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml
index 2c0dc355e..d247a7e29 100644
--- a/.github/workflows/checks.yml
+++ b/.github/workflows/checks.yml
@@ -20,7 +20,7 @@ jobs:
- name: Set up Python & Poetry Environment
id: set-up-python-and-poetry-environment
- uses: exasol/python-toolbox/.github/actions/python-environment@v9
+ uses: exasol/python-toolbox/.github/actions/python-environment@v10
with:
python-version: "3.10"
poetry-version: "2.3.0"
@@ -48,7 +48,7 @@ jobs:
- name: Set up Python & Poetry Environment
id: set-up-python-and-poetry-environment
- uses: exasol/python-toolbox/.github/actions/python-environment@v9
+ uses: exasol/python-toolbox/.github/actions/python-environment@v10
with:
python-version: "3.10"
poetry-version: "2.3.0"
@@ -75,7 +75,7 @@ jobs:
- name: Set up Python & Poetry Environment
id: set-up-python-and-poetry-environment
- uses: exasol/python-toolbox/.github/actions/python-environment@v9
+ uses: exasol/python-toolbox/.github/actions/python-environment@v10
with:
python-version: ${{ matrix.python-versions }}
poetry-version: "2.3.0"
@@ -113,7 +113,7 @@ jobs:
- name: Set up Python & Poetry Environment
id: set-up-python-and-poetry-environment
- uses: exasol/python-toolbox/.github/actions/python-environment@v9
+ uses: exasol/python-toolbox/.github/actions/python-environment@v10
with:
python-version: ${{ matrix.python-versions }}
poetry-version: "2.3.0"
@@ -141,7 +141,7 @@ jobs:
- name: Set up Python & Poetry Environment
id: set-up-python-and-poetry-environment
- uses: exasol/python-toolbox/.github/actions/python-environment@v9
+ uses: exasol/python-toolbox/.github/actions/python-environment@v10
with:
python-version: ${{ matrix.python-versions }}
poetry-version: "2.3.0"
@@ -173,7 +173,7 @@ jobs:
- name: Set up Python & Poetry Environment
id: set-up-python-and-poetry-environment
- uses: exasol/python-toolbox/.github/actions/python-environment@v9
+ uses: exasol/python-toolbox/.github/actions/python-environment@v10
with:
python-version: "3.10"
poetry-version: "2.3.0"
@@ -196,7 +196,7 @@ jobs:
- name: Set up Python & Poetry Environment
id: set-up-python-and-poetry-environment
- uses: exasol/python-toolbox/.github/actions/python-environment@v9
+ uses: exasol/python-toolbox/.github/actions/python-environment@v10
with:
python-version: "3.10"
poetry-version: "2.3.0"
@@ -219,7 +219,7 @@ jobs:
- name: Set up Python & Poetry Environment
id: set-up-python-and-poetry-environment
- uses: exasol/python-toolbox/.github/actions/python-environment@v9
+ uses: exasol/python-toolbox/.github/actions/python-environment@v10
with:
python-version: "3.10"
poetry-version: "2.3.0"
@@ -242,7 +242,7 @@ jobs:
- name: Set up Python & Poetry Environment
id: set-up-python-and-poetry-environment
- uses: exasol/python-toolbox/.github/actions/python-environment@v9
+ uses: exasol/python-toolbox/.github/actions/python-environment@v10
with:
python-version: "3.10"
poetry-version: "2.3.0"
diff --git a/.github/workflows/dependency-update.yml b/.github/workflows/dependency-update.yml
index 62cbc9c53..2945c41ee 100644
--- a/.github/workflows/dependency-update.yml
+++ b/.github/workflows/dependency-update.yml
@@ -35,7 +35,7 @@ jobs:
- name: Set up Python & Poetry Environment
id: set-up-python-and-poetry-environment
- uses: exasol/python-toolbox/.github/actions/python-environment@v9
+ uses: exasol/python-toolbox/.github/actions/python-environment@v10
with:
python-version: "3.10"
poetry-version: "2.3.0"
diff --git a/.github/workflows/fast-tests.yml b/.github/workflows/fast-tests.yml
index ac7faa679..3958495e7 100644
--- a/.github/workflows/fast-tests.yml
+++ b/.github/workflows/fast-tests.yml
@@ -25,7 +25,7 @@ jobs:
fetch-depth: 0
- name: Set up Python & Poetry Environment
id: set-up-python-and-poetry-environment
- uses: exasol/python-toolbox/.github/actions/python-environment@v9
+ uses: exasol/python-toolbox/.github/actions/python-environment@v10
with:
python-version: ${{ matrix.python-versions }}
poetry-version: "2.3.0"
diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml
index 134be7f44..ff05877bf 100644
--- a/.github/workflows/gh-pages.yml
+++ b/.github/workflows/gh-pages.yml
@@ -22,7 +22,7 @@ jobs:
- name: Set up Python & Poetry Environment
id: set-up-python-and-poetry-environment
- uses: exasol/python-toolbox/.github/actions/python-environment@v9
+ uses: exasol/python-toolbox/.github/actions/python-environment@v10
with:
python-version: "3.10"
poetry-version: "2.3.0"
diff --git a/.github/workflows/matrix.yml b/.github/workflows/matrix.yml
index c0476ae0c..de338684a 100644
--- a/.github/workflows/matrix.yml
+++ b/.github/workflows/matrix.yml
@@ -28,7 +28,7 @@ jobs:
- name: Set up Python & Poetry Environment
id: set-up-python-and-poetry-environment
- uses: exasol/python-toolbox/.github/actions/python-environment@v9
+ uses: exasol/python-toolbox/.github/actions/python-environment@v10
with:
python-version: "3.10"
poetry-version: "2.3.0"
diff --git a/.github/workflows/report.yml b/.github/workflows/report.yml
index 621a6447d..5df42e9e6 100644
--- a/.github/workflows/report.yml
+++ b/.github/workflows/report.yml
@@ -24,7 +24,7 @@ jobs:
- name: Set up Python & Poetry Environment
id: set-up-python-and-poetry-environment
- uses: exasol/python-toolbox/.github/actions/python-environment@v9
+ uses: exasol/python-toolbox/.github/actions/python-environment@v10
with:
python-version: "3.10"
poetry-version: "2.3.0"
diff --git a/.github/workflows/slow-checks.yml b/.github/workflows/slow-checks.yml
index 9b040ed10..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
@@ -33,7 +34,7 @@ jobs:
- name: Set up Python & Poetry Environment
id: set-up-python-and-poetry-environment
- uses: exasol/python-toolbox/.github/actions/python-environment@v8
+ uses: exasol/python-toolbox/.github/actions/python-environment@v10
with:
python-version: ${{ matrix.python_versions }}
poetry-version: "2.3.0"
diff --git a/doc/changes/unreleased.md b/doc/changes/unreleased.md
index fb4737052..54abf9712 100644
--- a/doc/changes/unreleased.md
+++ b/doc/changes/unreleased.md
@@ -1,3 +1,10 @@
# Unreleased
## 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
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.