Skip to content

Update docs theme 1.2.1#129

Closed
dgarcia360 wants to merge 3 commits intoscylladb:scylla-3.xfrom
dgarcia360:update-docs-theme-1.2.1
Closed

Update docs theme 1.2.1#129
dgarcia360 wants to merge 3 commits intoscylladb:scylla-3.xfrom
dgarcia360:update-docs-theme-1.2.1

Conversation

@dgarcia360
Copy link
Copy Markdown

Related issue scylladb/sphinx-scylladb-theme#310

ScyllaDB Sphinx Theme 1.2.1 is now released 🥳

We’ve added automatic checks for broken links 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://127.0.0.1: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.2.x:

image

@avelanarius
Copy link
Copy Markdown

avelanarius commented May 17, 2022

@dgarcia360 As you have surely seen, after this PR GitHub Actions job building docs (as well as other jobs) fails with:

 Error: error: unable to create symlink docs/source/index.md: File name too long

@dgarcia360 dgarcia360 force-pushed the update-docs-theme-1.2.1 branch from e2ba92a to 2f4d4ef Compare May 20, 2022 13:34
docs: update dynamic slug

Add back index.md

Move custom slug to a separate PR

Fix typo
@dgarcia360 dgarcia360 force-pushed the update-docs-theme-1.2.1 branch from 2f4d4ef to b0efc1b Compare May 20, 2022 13:39
@dgarcia360 dgarcia360 marked this pull request as ready for review May 20, 2022 15:42
@dgarcia360
Copy link
Copy Markdown
Author

@avelanarius Thanks, fixed! It's now ready for review.

@annastuchlik
Copy link
Copy Markdown

@avelanarius Is it possible for you to verify this PR on Linux and merge it if it's ok?

Comment thread .github/workflows/docs-pages.yaml
Comment thread README-dev.md Outdated
Co-authored-by: Piotr Grabowski <[email protected]>
@dgarcia360 dgarcia360 requested a review from avelanarius May 24, 2022 10:41
@avelanarius
Copy link
Copy Markdown

Merged via 8feeb20 (squashed commits into one).

@annastuchlik
Copy link
Copy Markdown

@dgarcia360 @avelanarius Thank you!

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.

3 participants