Skip to content

docs: update theme 1.1#10054

Merged
scylladb-promoter merged 2 commits intoscylladb:masterfrom
dgarcia360:docs-update-theme-1.1
Feb 10, 2022
Merged

docs: update theme 1.1#10054
scylladb-promoter merged 2 commits intoscylladb:masterfrom
dgarcia360:docs-update-theme-1.1

Conversation

@dgarcia360
Copy link
Copy Markdown
Contributor

Related issue scylladb/sphinx-scylladb-theme#310

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.

⚠️Breaking changes

Before, the theme installed poetry 1.1.x as a dependency to manage Python dependencies. However, poetry 1.2.x changed 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:

  1. Uninstall Poetry 1.1.x.
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | POETRY_UNINSTALL=1 python -
  1. Install Poetry 1.2.x. For detailed instructions, see Poetry installation.

How to test this PR

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

  2. Uninstall poetry 1.1 and install poetry 1.2. For more information, see Breaking changes notice above.

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

image

@dgarcia360 dgarcia360 marked this pull request as draft February 9, 2022 11:18
@dgarcia360 dgarcia360 marked this pull request as ready for review February 9, 2022 11:27
@scylladb-promoter scylladb-promoter merged commit 2e2b542 into scylladb:master Feb 10, 2022
@dgarcia360 dgarcia360 deleted the docs-update-theme-1.1 branch February 10, 2022 15:01
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.

2 participants