Google Git
Sign in
qemu / qemu / adcb9b36c9b0a63e3b0cf81994430cfb0d720571
commitadcb9b36c9b0a63e3b0cf81994430cfb0d720571[log] [tgz]
authorJohn Snow <jsnow@redhat.com>Fri Oct 09 12:15:24 2020 -0400
committerMarkus Armbruster <armbru@redhat.com>Sat Oct 10 11:37:46 2020 +0200
tree0489b8cea9f6ec7766c74258839a1c0bdf2eb37b
parent1ec43ca42e153414f586aeda45f37acffbfd1ca1 [diff]
qapi: modify docstrings to be sphinx-compatible

A precise style guide and a package-wide overhaul is forthcoming pending
further discussion and consensus. For now, merely avoid obvious errors
that cause Sphinx documentation build problems, using a style loosely
based on PEP 257 and Sphinx Autodoc. It is chosen for interoperability
with our existing Sphinx framework, and because it has loose recognition
in the Pycharm IDE.

See also:

https://www.python.org/dev/peps/pep-0257/
https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#info-field-lists
Signed-off-by: John Snow <jsnow@redhat.com>
Message-Id: <20201009161558.107041-3-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
1 file changed
tree: 0489b8cea9f6ec7766c74258839a1c0bdf2eb37b
  1. .github/
  2. .gitlab-ci.d/
  3. accel/
  4. audio/
  5. authz/
  6. backends/
  7. block/
  8. bsd-user/
  9. chardev/
  10. contrib/
  11. crypto/
  12. default-configs/
  13. disas/
  14. docs/
  15. dump/
  16. fpu/
  17. fsdev/
  18. gdb-xml/
  19. hw/
  20. include/
  21. io/
  22. libdecnumber/
  23. linux-headers/
  24. linux-user/
  25. migration/
  26. monitor/
  27. nbd/
  28. net/
  29. pc-bios/
  30. plugins/
  31. po/
  32. python/
  33. qapi/
  34. qga/
  35. qobject/
  36. qom/
  37. replay/
  38. roms/
  39. scripts/
  40. scsi/
  41. softmmu/
  42. storage-daemon/
  43. stubs/
  44. target/
  45. tcg/
  46. tests/
  47. tools/
  48. trace/
  49. ui/
  50. util/
  51. capstone
  52. dtc
  53. meson
  54. slirp
  55. .cirrus.yml
  56. .dir-locals.el
  57. .editorconfig
  58. .exrc
  59. .gdbinit
  60. .gitignore
  61. .gitlab-ci.yml
  62. .gitmodules
  63. .gitpublish
  64. .mailmap
  65. .patchew.yml
  66. .readthedocs.yml
  67. .shippable.yml
  68. .travis.yml
  69. block.c
  70. blockdev-nbd.c
  71. blockdev.c
  72. blockjob.c
  73. bootdevice.c
  74. Changelog
  75. CODING_STYLE.rst
  76. configure
  77. COPYING
  78. COPYING.LIB
  79. cpus-common.c
  80. device_tree.c
  81. disas.c
  82. dma-helpers.c
  83. exec-vary.c
  84. exec.c
  85. gdbstub.c
  86. gitdm.config
  87. hmp-commands-info.hx
  88. hmp-commands.hx
  89. iothread.c
  90. job-qmp.c
  91. job.c
  92. Kconfig
  93. Kconfig.host
  94. LICENSE
  95. MAINTAINERS
  96. Makefile
  97. memory_ldst.c.inc
  98. meson.build
  99. meson_options.txt
  100. module-common.c
  101. os-posix.c
  102. os-win32.c
  103. qdev-monitor.c
  104. qemu-bridge-helper.c
  105. qemu-edid.c
  106. qemu-img-cmds.hx
  107. qemu-img.c
  108. qemu-io-cmds.c
  109. qemu-io.c
  110. qemu-keymap.c
  111. qemu-nbd.c
  112. qemu-options-wrapper.h
  113. qemu-options.h
  114. qemu-options.hx
  115. qemu-seccomp.c
  116. qemu.nsi
  117. qemu.sasl
  118. README.rst
  119. replication.c
  120. replication.h
  121. thunk.c
  122. tpm.c
  123. trace-events
  124. VERSION
  125. version.rc
  126. version.texi.in