Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

JupyterBook integration tracking issue #48

Open
2 tasks
melissawm opened this issue Feb 10, 2023 · 0 comments
Open
2 tasks

JupyterBook integration tracking issue #48

melissawm opened this issue Feb 10, 2023 · 0 comments
Labels
bug Something isn't working

Comments

@melissawm
Copy link
Owner

melissawm commented Feb 10, 2023

Currently, sphinx-tags correctly generates tags for a JupyterBook, but there are some issues:

  • In individual tags pages, duplicate links may be generated to the pages containing that tag unless we use exclude_patterns : ["_build"] in the config.yml file for the book. Actually, this only happens if the jupyter-book build is run twice without deleting the _tags folder first.
  • Because JupyterBook uses the external-toctree extension, the individual autogenerated toctrees for the tags pages raise a WARNING: toctree directive not expected with external-toc [etoc.toctree]. A workaround is to use
sphinx:
  config:
    suppress_warnings: ["etoc.toctree"]

in the JupyterBook config.yml file.

cc @mikofski

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant