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

Various doc build improvements #290

Merged
merged 25 commits into from
Oct 27, 2023
Merged

Various doc build improvements #290

merged 25 commits into from
Oct 27, 2023

Conversation

maximlt
Copy link
Contributor

@maximlt maximlt commented Oct 24, 2023

Fixes #289
Fixes #207

image

Also:

  • Build the site directly with sphinx, no longer need nbsite build ...
  • Build the site without using the NotebookDirective from nbsite
  • Update nbsite (still needed to share CSS/templates and some config with other HoloViz sites) to its latest version
  • Built projects all moved to the /doc/gallery subfolder, to be able to generate a toctree for projects that have multiple files and having them available in the left side bar (5f94e65)
  • Redirect from the dummy homepage to the Gallery page
  • Notebook headers generated from another custom extension, not to have everything in the gallery extension
  • Fix Google Analytics setting
  • Fix rendering $ and Latex math expressions
  • Fix displaying images referenced from <img> HTML tags, using the html_image myst extension
  • Make the docs workflow a little faster
  • Don't include notebook sources in the built site (very heavy, not useful)
image image

@github-actions
Copy link
Contributor

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!).

@github-actions
Copy link
Contributor

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!).

@github-actions
Copy link
Contributor

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!).

@github-actions
Copy link
Contributor

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!).

@github-actions
Copy link
Contributor

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!).

@github-actions
Copy link
Contributor

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!).

@maximlt maximlt merged commit c2504db into main Oct 27, 2023
9 checks passed
@maximlt maximlt deleted the docs_improvements branch October 27, 2023 14:06
@maximlt maximlt mentioned this pull request Oct 30, 2023
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.

Build the docs for a project with all the project files included Links on Attractors panel not found
1 participant