search

canonical / pebble

Pebble is a lightweight Linux service manager with layered configuration and an HTTP API.
https://canonical-pebble.readthedocs-hosted.com/
GNU General Public License v3.0
145 stars 54 forks source link

Updated base structure for Pebble docs #420

Closed AnneCYH closed 4 months ago

AnneCYH commented 4 months ago

Several base updates for Pebble docs:

  1. Modified the necessary configuration values to reflect Pebble project.
  2. Updated conf.py to include the PR fixes from the Sphinx docs starter pack: https://github.com/canonical/sphinx-docs-starter-pack/pull/229/files.
  3. Added a live reload + serve option in tox.ini, similar to make run.
  4. Added the base folder structure to reflect Diataxis framework.
IronCore864 commented 4 months ago

The changes, especially the main page grid layout, is ported into another (kind of) duplicated PR here: https://github.com/canonical/pebble/pull/419. Closing this one for now. @AnneCYH