Include Titles in FileItems #88
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This fixes an issue where
sphinx-autoupdate
does not pick up changes to titles in the_toc.yaml
file.To reproduce, use the example project,
sphinx-autobuild --port 8001 . _build/
title
attributes to one of the files, egapi.md
You'll see that the change does not get picked up. The reason is that line 251 of
api.py
does an equality check on the items in the sitemap:prev_doc = previous[name]
.Since the title is included in the
Document
class, the changes in 2. and 3. above trigger a rebuild of theapi.md
. But the ToC is injected into theintro.md
file, which is unchanged both as a file and from the point of view of theget_changed
function.By including the titles on
FileItems
, such changes get picked up byget_changed
and the ToC updates correctly.