Skip to content

Commit

Permalink
Fix setting rebuild condition
Browse files Browse the repository at this point in the history
Sphinx clarifies that this should be a literal type not, not a boolean
in general.
  • Loading branch information
jonathansick committed Apr 30, 2024
1 parent 424d658 commit 76babb7
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
2 changes: 2 additions & 0 deletions changelog.d/20240430_155714_jsick_DM_44137.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

- In `documenteer.ext.lssttasks`, attempt to import `_pseudo_parse_arglist` from `sphinx.domains.python._annotations` before falling back to the `sphinx.domains.python` module. Ultimately this is a workaround.

- Fix setting the rebuild condition for the `documenteer.ext.githubbibcache` extension.

### Other changes

- Added `defusedxml` as a dev dependency. This is used by Sphinx's `sphinx.testing.fixtures`, but isn't included as a dependency by Sphinx itself. This change ensures that `defusedxml` is installed when running the tests.
4 changes: 2 additions & 2 deletions src/documenteer/ext/githubbibcache.py
Original file line number Diff line number Diff line change
Expand Up @@ -116,11 +116,11 @@ def cache_bibfiles(app: Sphinx, config: Config) -> None:
def setup(app: Sphinx) -> dict[str, Any]:
"""Set up the ``documenteer.ext.autocppapi`` Sphinx extensions."""
# Configuration values
app.add_config_value("documenteer_bibfile_github_repos", "", True, [list])
app.add_config_value("documenteer_bibfile_github_repos", "", "env", [list])
app.add_config_value(
"documenteer_bibfile_cache_dir",
Path("_build/bibfile-cache"),
True,
"env",
[str, Path],
)
app.connect("config-inited", cache_bibfiles)
Expand Down

0 comments on commit 76babb7

Please sign in to comment.