- ⬆️ UPGRADE: Support
sphinx5
#85
- ⬆️ UPGRADE: Drop python 3.6 support (#75)
- ♻️ REFACTOR: Replace
attrs
with built-indataclasses
(#76) - 🐛 FIX: gettext builder compatibility
- 🐛 FIX: Inserting toctree into empty document (#77)
- 🔧 MAINTAIN: Move from setuptools to flit, for PEP 621 packaging (#74)
- ⬆️ UPGRADE: allow click v8 by @lukasbindreiter in executablebooks#69
- 📚: Fix ToC graphic link by @ZviBaratz in executablebooks#63
- 🔧 MAINTAIN: Updated parser docstrings by @ZviBaratz in executablebooks#61
- 🔧 MAINTAIN: Removed unused argument by @ZviBaratz in executablebooks#66
- 🔧 MAINTAIN: Updated
api
docstrings by @ZviBaratz in executablebooks#64 - 🔧: Docstring updates by @ZviBaratz in executablebooks#67
- @ZviBaratz made their first contribution in executablebooks#61
- @lukasbindreiter made their first contribution in executablebooks#69
Full Changelog: https://github.com/executablebooks/sphinx-external-toc/compare/v0.2.3...v0.2.4
🔧 MAINTAIN: Update attrs
minimum version to 20.3
, when value_serializer
was introduced (required here).
👌 IMPROVE: Changed document identification.
The comparison of sitemaps and identification of changed documents to rebuild was improved and moved to SiteMap.get_changed
.
🐛 FIX: File extensions in ToC
Ensure files are still matched, if they are provided with file extensions.
- ⬆️ UPDATE: Relax dependency pinning to allow Sphinx v4
- ‼ BREAKING: the CLI command
to-site
is nowto-project
, andfrom-site
is nowfrom-project
- ♻️ REFACTOR: key
items
->entries
- 👌 IMPROVE: Add
--output
tomigrate
command
- 👌 IMPROVE: validate URL: Ensure value of
url
keys match regex used by Sphinx to identify them - 🐛 FIX:
external_toc_path
with absolute path
- 👌 IMPROVE: Parsing
MalformedError
messages - 👌 IMPROVE: jupyter-book migration
- Better conversion validation
- Move
options
key aboveparts
/chapters
/sections
key
- 👌 IMPROVE: Add
ensure_index_file
event on build completion - ♻️ REFACTOR: Rename key:
parts
->subtrees
- ♻️ REFACTOR:
sections
->items
, and addformat
- The
format
key adds key-mapping for jupyter-book support.
- The
- ♻️ REFACTOR: API naming: renamed to be more general:
DocItem
->Document
DocItem.parts
->Document.subtrees
TocItem
->TocTree
TocItem.sections
->TocTree.items
🐛 FIX: numbered: true
, this was being equated to numbered: 1
rather than numbered: 999
(i.e. infinite depth).
- ♻️ REFACTOR: Move parsing code to separate module
- ✨ NEW: Improve option parsing, add jupyter-book migration
👌 IMPROVE: toc.yml
validation
🐛 FIX: for nested docnames in sub-folders
Initial alpha release.