Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update theme 1.1 #57

Merged
merged 3 commits into from
May 10, 2022
Merged

Conversation

dgarcia360
Copy link

Related issue scylladb/sphinx-scylladb-theme#310

ScyllaDB Sphinx Theme 1.1 is now released 馃コ

We鈥檝e 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 changed the title Update theme 1.1 docs: update theme 1.1 Feb 11, 2022
@dgarcia360
Copy link
Author

@tzach please review

@dgarcia360
Copy link
Author

@tzach @jul-stas please review

@dgarcia360
Copy link
Author

@tzach @annastuchlik I'd like to merge this PR before updating to 1.2.1. Could you please merge this when you have some time?

Thanks!

@tzach
Copy link

tzach commented Apr 3, 2022

LGTM

@annastuchlik
Copy link

@jul-stas Could you merge this PR? We'd like to move on and update the theme to version 1.2 to be in sync with other projects.

@jul-stas jul-stas self-requested a review May 10, 2022 11:11
@jul-stas jul-stas merged commit ceb5296 into scylladb:master May 10, 2022
@dgarcia360 dgarcia360 deleted the update-theme-1.1 branch May 10, 2022 11:41
@annastuchlik
Copy link

@jul-stas 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.

None yet

4 participants