docs: update theme 1.1 #56
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@tzach Please review |
tzach
reviewed
Feb 2, 2022
| @@ -0,0 +1,31 @@ | |||
| name: "Docs / Publish" | |||
There was a problem hiding this comment.
what are the updates in the action?
Its hard to understand the update when we have a new file
There was a problem hiding this comment.
| @@ -76,7 +56,6 @@ def setup(sphinx): | |||
| 'github_issues_repository': 'scylladb/care-pet', | |||
| 'github_repository': 'scylladb/care-pet', | |||
| 'hide_edit_this_page_button': 'false', | |||
| 'hide_sidebar_index': 'true', | |||
There was a problem hiding this comment.
| @@ -76,7 +78,7 @@ | |||
|
|
|||
| .. raw:: html | |||
There was a problem hiding this comment.
do we still need HTML in the page?
There was a problem hiding this comment.
Yes, we managed to remove one html tag but the issue is still open: scylladb/sphinx-scylladb-theme#217
|
failed to build the docs |
Please see Breaking changes. |
15 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related issue scylladb/sphinx-scylladb-theme#133
ScyllaDB Sphinx Theme 1.1 is now released 🥳
We’ve made a number of updates to update all our dependencies to the latest version and introduced new directives you can use to write great docs.
You can read more about all notable changes here.
Before, the theme installed poetry 1.1.x as a dependency to manage Python dependencies. However,
poetry 1.2.xchanged the installation method. Therefore, we've decided to #307 Make poetry a prerequisite so that you can decide to install the poetry version you prefer.To preview the docs locally, you should uninstall the previous version of poetry. Then, install the latest version:
How to test this PR
Clone this PR. For more information, see Cloning pull requests locally.
Uninstall poetry 1.1 and install poetry 1.2. For more information, see Breaking changes notice above.
Enter the docs folder, and run:
1.1.x: