Re: [PATCH v5 02/36] qapi: modify docstrings to be sphinx-compatible

2020-10-07 Thread John Snow
On 10/7/20 3:24 AM, Markus Armbruster wrote: John Snow writes: On 10/6/20 7:21 AM, Markus Armbruster wrote: John Snow writes: A precise style guide and a package-wide overhaul is forthcoming pending further discussion and consensus. At present, we are avoiding obvious errors that cause sph

Re: [PATCH v5 02/36] qapi: modify docstrings to be sphinx-compatible

2020-10-07 Thread Markus Armbruster
John Snow writes: > On 10/6/20 7:21 AM, Markus Armbruster wrote: >> John Snow writes: >> >>> A precise style guide and a package-wide overhaul is forthcoming pending >>> further discussion and consensus. At present, we are avoiding obvious >>> errors that cause sphinx documentation build proble

Re: [PATCH v5 02/36] qapi: modify docstrings to be sphinx-compatible

2020-10-06 Thread John Snow
On 10/6/20 7:21 AM, Markus Armbruster wrote: John Snow writes: A precise style guide and a package-wide overhaul is forthcoming pending further discussion and consensus. At present, we are avoiding obvious errors that cause sphinx documentation build problems. A preliminary style guide is loo

Re: [PATCH v5 02/36] qapi: modify docstrings to be sphinx-compatible

2020-10-06 Thread Markus Armbruster
John Snow writes: > A precise style guide and a package-wide overhaul is forthcoming pending > further discussion and consensus. At present, we are avoiding obvious > errors that cause sphinx documentation build problems. > > A preliminary style guide is loosely based on PEP 257 and Sphinx > Auto

[PATCH v5 02/36] qapi: modify docstrings to be sphinx-compatible

2020-10-05 Thread John Snow
A precise style guide and a package-wide overhaul is forthcoming pending further discussion and consensus. At present, we are avoiding obvious errors that cause sphinx documentation build problems. A preliminary style guide is loosely based on PEP 257 and Sphinx Autodoc. It is chosen for interoper