canonical / sphinx-docs-starter-pack

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

The RST cheat sheet should not be actively bound to the landing page #50

Closed pmatulis closed 1 year ago

pmatulis commented 1 year ago

When integrating the pack into a code repository the landing page (index.rst) is naturally edited. However, because the RST cheat sheet and the landing page are bound together (in order to make the reuse example work in the cheat sheet) the doc build breaks.

ru-fu commented 1 year ago

Yes, agreed. I have it on my list to make sure the cheat sheet is completely independent. :)