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.7 #94

Merged
merged 1 commit into from
Jun 13, 2024
Merged

Conversation

dgarcia360
Copy link

Related issue scylladb/sphinx-scylladb-theme#1035

ScyllaDB Sphinx Theme 1.7 is out 🥳 Now, the docs will automatically publish when backporting changes to previous branches. This release also introduces minor style enhancements to the sidebar and homepage.

You can read more about all notable changes here.

How to test this PR

  1. Clone this PR. For more information, see Cloning pull requests locally.

  2. Enter the docs folder, and run:

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

image

@dgarcia360
Copy link
Author

cc/ @annastuchlik

@annastuchlik
Copy link

@avelanarius Could you review and merge this PR?

@roydahan
Copy link
Collaborator

BTW, this driver is about to be replaced with the newer driver: https://github.com/scylladb/cpp-rust-driver

@annastuchlik
Copy link

BTW, this driver is about to be replaced with the newer driver: https://github.com/scylladb/cpp-rust-driver

@roydahan Thanks for letting us know. The work on that project seems to be suspended. We need to add the docs to that project, just as we did for other projects - but I suggest doing that after the work is resumed.

In the meantime, we should continue updating the Sphinx them in this project.

@avelanarius Could you review and merge this PR?

@@ -6,6 +6,7 @@ on:
push:
branches:
- master
- 'branch-**'
Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't see any such branches in this project so I'm not sure why this change is here.
I guess it doesn't do any harm and we are unlikely to introduce any version branches in this repo, so it can stay.

Copy link
Author

@dgarcia360 dgarcia360 May 28, 2024

Choose a reason for hiding this comment

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

Exactly, we aimed to use the same file across repositories, but it's fine to remove this line for this project.

Suggested change
- 'branch-**'

@annastuchlik
Copy link

@avelanarius Can you merge this PR? It has been reviewed and approved.

@roydahan roydahan merged commit 1263a7f into scylladb:master Jun 13, 2024
1 check passed
@dgarcia360 dgarcia360 deleted the docs-update-theme-1.7 branch June 18, 2024 10:11
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