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 toolchain #3673

Merged
merged 30 commits into from
Jan 23, 2023

Conversation

bollwyvl
Copy link
Contributor

@bollwyvl bollwyvl commented Jan 22, 2023

References

Changes

  • replace nbsphinx with myst-nb
  • replace sphinx-rtd-theme with pydata-sphinx-theme
  • use jupyterlite directly
  • update prettier
    • apply to .md, .ya?ml
  • move index.rst to .md
  • update lerna
  • update eslint
  • update typescript
  • update CI action versions
  • add sphinx-autodoc-typehints
  • add intersphinx
  • add sphinx-copy-button
  • add typedoc
  • add jupyterlab-myst
  • reorganize docs structure around 4 kinds of docs
  • clean up broken markdown links
  • fix galata tests

Future Work

  • add dark theme variables
  • add docs for integrating with myst-nb (and potentially pydata-sphinx-theme and downstreams)
  • hoist preferred CDN URL (ick) to API somewhere
  • probably ship a known-good requirejs somewhere
  • add anchor-level pytest-check-links (especially for internal URLs)
  • squash more sphinx warnings, ideally getting to "fail on warning"
  • update prettier to consistently apply printWidth: 88 and proseWrap: always

@github-actions
Copy link

Binder 👈 Launch a binder notebook on branch bollwyvl/ipywidgets/gh-3656-update-docs

@bollwyvl bollwyvl changed the title Use myst-nb in docs Overhaul docs toolchain Jan 23, 2023
@bollwyvl bollwyvl marked this pull request as ready for review January 23, 2023 03:32
@bollwyvl
Copy link
Contributor Author

bollwyvl commented Jan 23, 2023

This is ready for a look on the RTD preview.

The galata stuff is broken, but at least installs... wouldn't see that as significant blocker.

@bollwyvl
Copy link
Contributor Author

Additionally, this could be teased into a series of PRs, but given there's no docs building right now, it would take a while to figure it out piecemeal.

@maartenbreddels
Copy link
Member

Thanks a lot for this Nick!

@bollwyvl
Copy link
Contributor Author

HA!. All ✔️.

@maartenbreddels maartenbreddels merged commit 6f6156c into jupyter-widgets:master Jan 23, 2023
@bollwyvl
Copy link
Contributor Author

Thanks all.

"Variable Inspector\\.ipynb"
],
"contents": ["../source/examples"],
"piplite_urls": [
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be moved under PipliteAddon now with the latest lite releases?

@bollwyvl
Copy link
Contributor Author

bollwyvl commented Jan 23, 2023 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Overhaul docs build chain
3 participants