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

[BUG] lonboard conflicts with most sphinx themes #698

Open
keewis opened this issue Oct 31, 2024 · 2 comments
Open

[BUG] lonboard conflicts with most sphinx themes #698

keewis opened this issue Oct 31, 2024 · 2 comments
Labels
bug Something isn't working

Comments

@keewis
Copy link

keewis commented Oct 31, 2024

Context

In xarray-contrib/xdggs#80 I've tried to build sphinx-based documentation that includes notebooks using lonboard maps using myst-nb (but nbsphinx has the same issue).

This turns out to mess up the text styles for most of the sphinx themes (the ones I tested were sphinx_book_theme, pydata_sphinx_theme and furo).

See the PR preview for how exactly this breaks.

I'm not sure if this is an issue with lonboard / its dependencies, or with the sphinx themes, though.

Environment

  • OS: ubuntu 24.04
  • Browser: firefox 131.0.3 and chromium 130.0.6723.69
  • Lonboard Version: 0.10.3

Steps to reproduce the bug

  1. Setup environment and install the dependencies
  2. Put conf.py, index.md, and the air-traffic-control notebook from the lonboard examples (might need to adjust the notebook kernel first, though) in a directory
  3. run python -m sphinx -M html -d _build/doctrees -W --keep-going -Ea -T -n . _build/html
  4. Compare _build/html/air-traffic-control.html with the one from the example in lonboard's documentation.
index.md
# Document Title

```{toctree}
air-traffic-control
```
conf.py
extensions = ["myst_nb"]
root_doc = "index"
html_theme = "sphinx_book_theme"
Dependencies
python                    3.12.7          hc5c86c4_0_cpython    conda-forge
sphinx                    8.1.3              pyhd8ed1ab_0    conda-forge
myst-nb                   1.1.2              pyhd8ed1ab_0    conda-forge
myst-parser               4.0.0              pyhd8ed1ab_0    conda-forge
lonboard                  0.10.3             pyh5bfe37b_0    conda-forge
sphinx-book-theme         1.1.3              pyhd8ed1ab_0    conda-forge
pydata-sphinx-theme       0.15.4             pyhd8ed1ab_0    conda-forge
furo                      2024.8.6           pyhd8ed1ab_1    conda-forge
@keewis keewis added the bug Something isn't working label Oct 31, 2024
@kylebarron
Copy link
Member

This is probably similar to #696, but I don't quite understand the styling interactions enough to know the root cause.

@keewis
Copy link
Author

keewis commented Oct 31, 2024

well, me neither, which is why I wasn't able to investigate any further than that.

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

2 participants