scylladb / care-pet

Care Pet IoT ScyllaDB example
https://care-pet.docs.scylladb.com/
Apache License 2.0
47 stars 28 forks source link

docs: update theme 1.1 #56

Closed dgarcia360 closed 2 years ago

dgarcia360 commented 2 years ago

Related issue https://github.com/scylladb/sphinx-scylladb-theme/issues/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.

āš ļø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 commented 2 years ago

@tzach Please review

tzach commented 2 years ago

failed to build the docs

āœ” care-pet/docs [docs-theme-1-1|āœ”] 
09:03 $ make preview 
/home/tzach/.local/bin/poetry install
make: /home/tzach/.local/bin/poetry: No such file or directory
make: *** [Makefile:30: setup] Error 127
dgarcia360 commented 2 years ago

failed to build the docs

Please see Breaking changes.