search

holoviz-topics / examples

Visualization-focused examples of using HoloViz for specific topics
https://examples.holoviz.org
Creative Commons Attribution 4.0 International
82 stars 24 forks source link

Make it easier to build the doc locally for one project #367

Closed maximlt closed 7 months ago

maximlt commented 7 months ago

Adding a command to simplify building the dev site locally for a single project:

  1. Run the project notebook(s), don't clean their output
  2. doit doc_one --name <project> (for instance, doit doc_one --name boids): this command copies the notebooks in ./doc/gallery/<project> along with other files needed to build the docs (thumbnails, archive, assets, etc.), and build the docs with Sphinx
  3. visit the built site opening ./builtdocs/index.html, I run open ./builtdocs/index.html on my machine
  4. clean up with doit clean doc_one
github-actions[bot] commented 7 months ago

Your changes were successfully integrated in the dev site, make sure to review the pages of the projects you touched before merging this PR: https://holoviz-dev.github.io/examples/. You can also download an archive of the site from the workflow summary page which comes in handy when your dev site built was overriden by another PR (we have a single dev site!).