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

Overhaul docs build chain #3656

Closed
bollwyvl opened this issue Dec 22, 2022 · 0 comments · Fixed by #3673
Closed

Overhaul docs build chain #3656

bollwyvl opened this issue Dec 22, 2022 · 0 comments · Fixed by #3673
Labels

Comments

@bollwyvl
Copy link
Contributor

bollwyvl commented Dec 22, 2022

References

Problem

The docs don't currently build.

Suggested Improvement

  • use myst-nb
    • under more active development than nbsphinx, and provides some nice features
    • some of its typographical features translate nicely into the lab experience with jupyterlab-myst
    • has better notebook execution caching for iteration
    • has better observability of failures and options for executing notebooks
  • use pydata-sphinx-theme
    • better use of screen real estate
    • slightly more complex to get a good nav structure
  • use jupyterlite directly vs jupyterlite-sphinx
    • allows for sphinx 5 (jupyterlite-sphinx pins to <5, don't know or care why)
    • would allow building the lite demo without the full docs site
      • which takes a long time, though that would be helped above
  • add typedoc
    • i've been using a markdown theme, and then having myst-nb take care of it
      • this allows typescript APIs to be discoverable in the unified sphinx search
        • even though the output is somewhat suboptimal
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant