Skip to content

Commit ba976db

Browse files
authored
Release v1.1.0 with advanced section numbering (#114)
* Release v1.1.0 with advanced section numbering Update version to 1.1.0 and changelog to document the new advanced section numbering customization feature. Minor cleanup in README to reflect recent changes.
1 parent 29ff697 commit ba976db

File tree

4 files changed

+10
-4
lines changed

4 files changed

+10
-4
lines changed

.github/workflows/tests.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ jobs:
4242
pytest --cov=sphinx_external_toc --cov-report=xml --cov-report=term-missing
4343
- name: Upload to Codecov
4444
if: matrix.python-version == '3.14'
45-
uses: codecov/codecov-action@v4
45+
uses: codecov/codecov-action@v3
4646
with:
4747
name: pytests-py3.14
4848
flags: pytests

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Change Log
22

3+
## v1.1.0 - 2025-01-16
4+
5+
([full changelog](https://github.com/executablebooks/sphinx-external-toc/compare/v1.0.1...v1.1.0))
6+
7+
### Added
8+
9+
- NEW: Advanced section numbering customization by @douden in https://github.com/executablebooks/sphinx-external-toc/pull/112
10+
311
## v1.0.1 - 2023-12-12
412

513
([full changelog](https://github.com/executablebooks/sphinx-external-toc/compare/v1.0.0...21adcf94ca0e09e7fbce21bf87734435520169f2))

README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -450,13 +450,11 @@ meta: {}
450450

451451
Questions / TODOs:
452452

453-
- ~~Add additional top-level keys, e.g. `appendices` (see https://github.com/sphinx-doc/sphinx/issues/2502) and `bibliography`.~~ Can be replaced by setting the numbering style and (possibly) restarting the numbering.
454453
- Using `external_toc_exclude_missing` to exclude a certain file suffix:
455454
currently if you had files `doc.md` and `doc.rst`, and put `doc.md` in your ToC,
456455
it will add `doc.rst` to the excluded patterns but then, when looking for `doc.md`,
457456
will still select `doc.rst` (since it is first in `source_suffix`).
458457
Maybe open an issue on sphinx, that `doc2path` should respect exclude patterns.
459-
- ~~Integrate https://github.com/executablebooks/sphinx-multitoc-numbering into this extension? (or upstream PR).~~ Included and enforced in this fork.
460458
- document suppressing warnings
461459
- test against orphan file
462460
- https://github.com/executablebooks/sphinx-book-theme/pull/304

sphinx_external_toc/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
if TYPE_CHECKING:
66
from sphinx.application import Sphinx
77

8-
__version__ = "1.1.0-dev"
8+
__version__ = "1.1.0"
99

1010

1111
def setup(app: "Sphinx") -> dict:

0 commit comments

Comments
 (0)