4 Commits

Author	SHA1	Message	Date
Andrea Bolognani	673cde43d4	docs: Document list-tables as recommended ... Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>	2020-05-11 13:55:27 +02:00
Andrea Bolognani	52b51b55a2	docs: Add section about code blocks to styleguide.rst ... Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>	2020-04-16 18:58:07 +02:00
Daniel P. Berrangé	e00b09c663	docs: describe the basic RST structure for a man page ... Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>	2019-12-11 14:28:41 +00:00
Daniel P. Berrangé	fc721b0878	docs: add a minimal style guide for writing RST docs ... Most importantly we document the required heading markup so that we get consistency across the docs. Also mention that docs should have a table of contents if they have headings & are likely longer than one page of text. The 3-space indent rule may sound wierd, but that's what python has recommended and thus what tools like pandoc emit. Rather than try to reindent things to 4-space, just accept this RST norm. Reviewed-by: Michal Privoznik <mprivozn@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>	2019-12-04 15:48:28 +00:00