search

scylladb / care-pet

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

Lint documentation configuration #43

Closed dgarcia360 closed 2 years ago

dgarcia360 commented 2 years ago

Related https://github.com/scylladb/sphinx-scylladb-theme/issues/133

Context

care-pet was one of the first projects to receive the Scylla Sphinx Theme 1.0 update.

After adding the docs to other projects, we have improved the GitHub Actions workflows and organized the conf.py similarly for all projects. This PR applies these changes to the care-pet project.

How to test this PR

  1. Clone this PR. For more information, see Cloning pull requests locally.
  1. Enter the docs folder, and run:
make preview
  1. Open http://127.0.0.1:5500/ with your favorite browser. You will see the docs and the terminal should not raise any warnings.
dgarcia360 commented 2 years ago

@tzach Please review

tzach commented 2 years ago

FYI @sitano is not part of the Scylla team anymore (still welcome to comment ;)