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

Setting up infrastructure for documentation and jupyterlite #82

Merged
merged 48 commits into from
Dec 11, 2023
Merged

Conversation

hoxbro
Copy link
Member

@hoxbro hoxbro commented Dec 5, 2023

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 and hatch run docs:server for building the docs, and hatch run lite:build and hatch 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

Copy link

codspeed-hq bot commented Dec 5, 2023

CodSpeed Performance Report

Merging #82 will not alter performance

⚠️ No base runs were found

Falling back to comparing docs (968e255) with main (8d8132d)

Summary

✅ 6 untouched benchmarks

Copy link
Member

@jbednar jbednar left a comment

Choose a reason for hiding this comment

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

Nice!

doc/apps/index.md Outdated Show resolved Hide resolved
doc/index.md Outdated Show resolved Hide resolved
@ahuang11
Copy link
Contributor

ahuang11 commented Dec 6, 2023

Excited to see the docs :)

Copy link
Member

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.

Copy link
Member Author

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.

@maximlt
Copy link
Member

maximlt commented Dec 7, 2023

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 /doc instead of in /examples. This is what Param does, although Param doesn't build JupyterLite so there may be other things to adapt.

It doesn't mean nbsites is no longer a dependency, it should still be one to pull the shared templates and CSS.

@jbednar jbednar changed the title Setting up infrastructure for documenation and jupyterlite Setting up infrastructure for documentation and jupyterlite Dec 8, 2023
@hoxbro hoxbro merged commit 3b575b9 into main Dec 11, 2023
19 checks passed
@hoxbro hoxbro deleted the docs branch December 11, 2023 16:57
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.

None yet

4 participants