Skip to content

docs: update theme 1.3#11330

Closed
dgarcia360 wants to merge 1 commit intoscylladb:masterfrom
dgarcia360:docs-update-theme-1.3
Closed

docs: update theme 1.3#11330
dgarcia360 wants to merge 1 commit intoscylladb:masterfrom
dgarcia360:docs-update-theme-1.3

Conversation

@dgarcia360
Copy link
Copy Markdown
Contributor

@dgarcia360 dgarcia360 commented Aug 19, 2022 •
edited
Loading

Related issue scylladb/sphinx-scylladb-theme#548

ScyllaDB Sphinx Theme 1.3 is now released 🥳

We’ve added better redirects support and introduced numerous UI updates.

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
  1. 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.3.x:

image

@dgarcia360
Copy link
Copy Markdown
Contributor Author

dgarcia360 commented Aug 19, 2022

@annastuchlik @tzach please review

@dgarcia360 dgarcia360 mentioned this pull request Aug 19, 2022
Closed
5 tasks
@dgarcia360
docs: update theme 1.3
eb431d1 
Update conf.py
@dgarcia360 dgarcia360 force-pushed the docs-update-theme-1.3 branch from 2e7e934 to eb431d1 Compare August 19, 2022 12:45
@annastuchlik
Copy link
Copy Markdown
Collaborator

annastuchlik commented Aug 29, 2022

@dgarcia360 I'm not sure we can merge this PR. Can we discuss the following?

  • When I run make preview the build succeeds and the landing page looks OK, but running run multiversion returns errors and the page is not rendered properly or not rendered at all.
  • The hide_version_dropdown and hide_versions_dropdown options are missing from the conf.py file in this PR.

@dgarcia360
Copy link
Copy Markdown
Contributor Author

dgarcia360 commented Sep 6, 2022

@annastuchlik I could not reproduce the errors:

gh repo clone scylladb/scylladb
cd scylladb
gh pr checkout 11330
cd docs
make multiversionpreview

Renders:

image

Could you please share the error logs?

The hide_version_dropdown and hide_versions_dropdown options are missing from the conf.py file in this PR.

In this repository, we want to show the dropdown even if there is only "master" version, so we don't need the option hide_version_dropdown (defaults to empty array) nor hide_version_dropdown (defaults to false).

@annastuchlik annastuchlik added the documentation Requires documentation label Sep 15, 2022
@tzach
Copy link
Copy Markdown
Contributor

tzach commented Sep 15, 2022

Looks good to me

@annastuchlik annastuchlik self-requested a review September 15, 2022 09:15
annastuchlik
annastuchlik approved these changes Sep 15, 2022
View reviewed changes
Copy link
Copy Markdown
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.

This PR can be merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@annastuchlik annastuchlik annastuchlik approved these changes

Assignees

No one assigned

Labels

documentation Requires documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@dgarcia360 @annastuchlik @tzach