Suggest

[waveform80]

Some suggestions for the reST documentation. Each commit is a separate suggestion; if any aren't desirable, I'm happy to rebase and remove them!

(cherry-picked from the archived canonical/sphinx-docs-guide#25 as suggested in that PR)

• Have you updated CHANGELOG.md with relevant non-documentation file changes?
• Have you updated the documentation for this change?

[rkratky]

Thanks. LGTM. Just a bunch of nits. Pre-approving.

[SecondSkoll]

Suggested change

	## NEW-VERSION
	### Changed
	* `docs/reference/style-guide.rst` [97fcd55](https://github.com/canonical/sphinx-docs-starter-pack/commit/97fcd55c9e5d52b639a9490b6eaf30d213638ce8) -- Remove impossible warning
	* `docs/reference/style-guide.rst` [edd848a](https://github.com/canonical/sphinx-docs-starter-pack/commit/edd848a24ef8781fe676e214456cb0c5d0089dec) -- Correct underline definition
	* `docs/reference/style-guide.rst` [c8e71d7](https://github.com/canonical/sphinx-docs-starter-pack/commit/c8e71d7dea5964df42396d330e29fad501b97ca2) -- Only use admonitions advised by the style guide
	* `docs/reference/style-guide.rst` [3ff16f2](https://github.com/canonical/sphinx-docs-starter-pack/commit/3ff16f2ac465907024d2a3c7d823e8ce1a9490ca) -- Add section on linking to Ubuntu man-pages
	* `docs/reference/style-guide.rst` [5bda4da](https://github.com/canonical/sphinx-docs-starter-pack/commit/5bda4daa0943af153d9604da45be47bbccc1cda5) -- Add note about image output formats

I haven't figured out the best practice for this, but the changelog is not intended for documentation of the starter pack itself as it's used as a reference when updating starter pack versions. Adding a disclaimer in the file is also not that helpful if we want to minimise the output from that function... but maybe I should add something in here.

Anyway, this isn't necessary to add to this file as the changes are documentation based and aren't relevant for the use case of this file - documentation sets based on this repository upgrading versions.

[waveform80]

Ah, that makes sense -- I'll fix up my other PR (#373) in a bit too (removing the CHANGELOG bits in there)

[waveform80]

I've rebased to simply excise that commit