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

docs: update theme 1.8 #18

Merged
merged 1 commit into from
Sep 26, 2024
Merged

docs: update theme 1.8 #18

merged 1 commit into from
Sep 26, 2024

Conversation

dgarcia360
Copy link
Collaborator

@dgarcia360 dgarcia360 commented Sep 26, 2024

Related issue scylladb/sphinx-scylladb-theme#1229

ScyllaDB Sphinx Theme 1.8 is out 🥳!
image

Here's a summary of changes:

  • Dark theme support for a fresh new look.
  • Updated branding assets including new logos and mascots.
  • Improved build process by recommending the inclusion of the poetry.lock file to ensure consistent dependencies in your CI/CD pipeline.
  • New tooltip component to add more context to glossary terms, configuration parameters, or any other elements without cluttering the page.

You can read more about all the notable changes here.

How to test this PR

  1. Clone this PR.

  2. Enter the docs folder, and run:

    make preview
    
  3. Open http://localhost:5500 in your browser. The doc should render without errors, and the version should be Sphinx Theme version (see the footer) must be 1.8.x:

    image

@dgarcia360 dgarcia360 marked this pull request as ready for review September 26, 2024 12:14
Copy link
Collaborator

@annastuchlik annastuchlik left a comment

Choose a reason for hiding this comment

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

LGTM

@annastuchlik annastuchlik merged commit f8c6f06 into main Sep 26, 2024
1 check 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.

2 participants