liran-funaro / sphinx-markdown-builder / 43182526669

100%

push

github

Rebuild the output when a markdown_* option changes (#124)

## Summary

Every `markdown_*` option was registered with the rebuild level
`"html"`. Sphinx only treats `"html"` changes as relevant to the HTML
builders, and `MarkdownBuilder.get_outdated_docs()` only compares
mtimes, so changing an option and rebuilding without `-a`/`-E` rewrote
nothing. This registers all options with `"env"`, so a config change
invalidates the environment and every document is re-read and rewritten.

Adds one test, `test_config_change_rebuilds_output`, that builds into
`tmp_path` and rebuilds with only `markdown_anchor_sections` changed. A
diff test always builds with `-a`, so it cannot check an incremental
build; that is why this is a pytest. The test fails on `main` and passes
with this change.

Note: open PR #109 adds `markdown_suppress_comments` with `"html"`. It
should switch to `"env"` once this lands.

## Before / after

`index.rst` is `Title\n=====`. First build, then `sphinx-build -b
markdown src out -D markdown_anchor_sections=1`:

Before (`index.md` is unchanged):
```markdown
# Title
```

After:
```markdown
<a id="title"></a>

# Title
```

## Commands

- `make lint`: passed (pylint 10.00/10)
- `make test`: passed (diff clean, 16 passed, coverage 100%)
- `pytest tests/test_builder.py -k config_change` with `"html"`
restored: fails as expected

Closes #110

9 of 9 new or added lines in 1 file covered. (100.0%)

778 of 778 relevant lines covered (100.0%)

4.0 hits per line