Skip to content

docs: update theme 1.3#154

Merged
avelanarius merged 3 commits intoscylladb:scylla-3.xfrom
dgarcia360:docs-update-theme-1.3
Jan 18, 2023
Merged

docs: update theme 1.3#154
avelanarius merged 3 commits intoscylladb:scylla-3.xfrom
dgarcia360:docs-update-theme-1.3

Conversation

@dgarcia360
Copy link
Copy Markdown

@dgarcia360 dgarcia360 commented Aug 19, 2022

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://http://localhost:3000 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 dgarcia360 marked this pull request as ready for review September 13, 2022 09:04
@dgarcia360
Copy link
Copy Markdown
Author

dgarcia360 commented Sep 13, 2022

@avelanarius could you please review and merge this PR? Thanks!

@avelanarius
Copy link
Copy Markdown

One problem I see after the update is that the "API Documentation" link in the sidebar stopped linking to the actual Javadocs-generated pages.

@avelanarius avelanarius force-pushed the scylla-3.x branch 2 times, most recently from 0d1c3e9 to f5fc83d Compare November 24, 2022 11:53
Fix javadoc redirect

Fix
@dgarcia360 dgarcia360 force-pushed the docs-update-theme-1.3 branch from 646bde3 to ac5be0a Compare December 8, 2022 14:55
@dgarcia360
Copy link
Copy Markdown
Author

dgarcia360 commented Dec 8, 2022

@avelanarius Sorry for the delay! I have some time now to revisit this issue.

ac5be0a solves the issue, "API Documentation" should redirect to the JavaDoc generated in production.

@annastuchlik
Copy link
Copy Markdown

annastuchlik commented Jan 17, 2023

@avelanarius Could you review and merge this PR? We must be merged before we move on with the next theme versions.

@avelanarius avelanarius merged commit a9fcffb into scylladb:scylla-3.x Jan 18, 2023
@annastuchlik
Copy link
Copy Markdown

@avelanarius Thank you! The current theme is now applied.

@dgarcia360 dgarcia360 deleted the docs-update-theme-1.3 branch January 19, 2023 08:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants