"Doc fields" are reST field lists in object descriptions that will be domain-specifically transformed to a more appealing presentation.
| Unknown Field: copyright | |
| Copyright 2007-2022 by the Sphinx team, see AUTHORS. | |
| Unknown Field: license | |
| BSD, see LICENSE for details. |
| Variable | logger |
Undocumented |
| Class | DocFieldTransformer |
Transforms field lists in "doc field" syntax into better-looking equivalents, using the field type definitions given on a domain. |
| Class | Field |
A doc field that is never grouped. It can have an argument or not, the argument can be linked using a specified rolename. Field should be used for doc fields that usually don't occur more than once. |
| Class | GroupedField |
No summary |
| Class | TypedField |
A doc field that is grouped and has type information for the arguments. It always has an argument. The argument can be linked using the given rolename, the type using the given typerolename. |
| Function | _is_single_paragraph |
True if the node only contains one paragraph (and system messages). |