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

Furo theme #3490

Merged
merged 4 commits into from
Nov 19, 2024
Merged

Furo theme #3490

merged 4 commits into from
Nov 19, 2024

Conversation

dwelsch-esi
Copy link
Contributor

Set up beta doc site using furo theme.
Includes:

  • Fill out folder structure for all TOC sections. Complete AdaRound example.
  • Make beta doc build optional for agile development.
  • Swap in furo theme for look & feel and right-side menu.
  • Refine furo theme options.
  • Set up index for API ref.

Squash merge Includes:
- Fill out folder structure for all TOC sections. Complete AdaRound example.
- Make beta doc build optional for agile development.
- Stripped beta piccolo theme CSS down to only modifications of the stock theme CSS.
- Swap in furo theme for look & feel and right-side menu.
- Refine furo theme options.
- More mods to furo theme. Set up index for API ref.

Signed-off-by: Dave Welsch <dwelsch@expertsupport.com>
Signed-off-by: Dave Welsch <dwelsch@expertsupport.com>
@@ -0,0 +1,10 @@
{# Add the ethical ads div, when generating documentation on Read the Docs #}
Copy link
Contributor

Choose a reason for hiding this comment

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

What does this do?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

TL;DR: We can delete it.

It's a component for the left sidebar that supports ReadTheDocs' advertising model. We don't use it.

All the flies in the _templates directory are already in the theme's package; they're not needed here unless we modify them. The only ones we're likely to modify are brand.html and navigation.html, which are the title heading and the TOC for the left sidebar.

Signed-off-by: Dave Welsch <dwelsch@expertsupport.com>
Docs/beta/featureguide/adaround.rst Show resolved Hide resolved
Docs/beta/featureguide/adaround.rst Show resolved Hide resolved
Docs/beta/snippets/torch/apply_adaround.py Show resolved Hide resolved
Docs/beta/snippets/torch/evaluate.py Outdated Show resolved Hide resolved
Docs/beta/snippets/torch/export.py Outdated Show resolved Hide resolved
Docs/beta/conf.py Show resolved Hide resolved
Signed-off-by: Dave Welsch <dwelsch@expertsupport.com>
@quic-hitameht quic-hitameht merged commit 3568d2b into quic:develop Nov 19, 2024
4 checks passed
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.

4 participants