-
Notifications
You must be signed in to change notification settings - Fork 1
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
Setting up infrastructure for documentation and jupyterlite #82
Conversation
CodSpeed Performance ReportMerging #82 will not alter performanceFalling back to comparing Summary
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice!
Co-authored-by: James A. Bednar <jbednar@anaconda.com>
Excited to see the docs :) |
doc/generate_modules.py
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm really unsure this file is used at all in the HoloViews build. Might wanna remove it here and see what happens.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I use it to create the reference manual pages.
Since it's a new project, you may want to avoid having to build the docs with nbsite directly (to avoid a layer of indirection that often comes in your way, e.g. when you want to use something like sphinx-autobuild), and stuff all the notebooks in It doesn't mean nbsites is no longer a dependency, it should still be one to pull the shared templates and CSS. |
[skip ci]
[skip ci]
[skip ci]
This set up the infrastructure to build docs and jupyterlite in HoloNote.
The doc files are heavily inspired by Panel (with holoviews colors). I have left chunks commented out as they could be needed later and will, in the future, either be uncommented or removed.
The example files have been moved into a subfolder.
This introduces the following commands:
hatch run docs:build
andhatch run docs:server
for building the docs, andhatch run lite:build
andhatch run lite:server
for building jupyterlite and launching the server.The dev website of docs can be found here: https://holoviz-dev.github.io/holonote/ and the dev website of the jupyterlite can be found here: https://holoviz-dev.github.io/holonote-jupyterlite/lab/index.html