search

canonical / sphinx-docs-starter-pack

A documentation starter-pack
https://canonical-starter-pack.readthedocs-hosted.com/
Other
15 stars 38 forks source link

Update readme for docs in code flow #233

Closed AnneCYH closed 4 months ago

AnneCYH commented 4 months ago

Updated the README instructions to work for docs-in-code repository workflow (related to issue #232), and to indicate other prerequisite packages / software to account for new users who are possibly working with these repositories for the first time.

Added @giuliazanchi who also went through some pains to get things up and running for the first time.

Other updates are formatting / syntax related updates.

Thanks!

Note: InvalidGitRepositoryError will be fixed in PR https://github.com/canonical/sphinx-docs-starter-pack/pull/229 .

giuliazanchi commented 4 months ago

@AnneCYH thanks for adding the requirement for python3.12-venv and python3-pip, your formatting fixes also LGTM

AnneCYH commented 4 months ago

Thanks @ru-fu , and noted on the feedback about lists especially. I'll squash the commits.