Revision 95eb4188 lib/build/sphinx_ext.py
| b/lib/build/sphinx_ext.py | ||
|---|---|---|
| 216 | 216 |
return [] |
| 217 | 217 |
|
| 218 | 218 |
|
| 219 |
def BuildQueryFields(fields): |
|
| 220 |
"""Build query fields documentation. |
|
| 221 |
|
|
| 222 |
@type fields: dict (field name as key, field details as value) |
|
| 223 |
|
|
| 224 |
""" |
|
| 225 |
for (_, (fdef, _, _)) in utils.NiceSort(fields.items(), |
|
| 226 |
key=operator.itemgetter(0)): |
|
| 227 |
assert len(fdef.doc.splitlines()) == 1 |
|
| 228 |
yield "``%s``" % fdef.name |
|
| 229 |
yield " %s" % fdef.doc |
|
| 230 |
|
|
| 231 |
|
|
| 232 |
# TODO: Implement Sphinx directive for query fields |
|
| 233 |
|
|
| 234 |
|
|
| 219 | 235 |
def setup(app): |
| 220 | 236 |
"""Sphinx extension callback. |
| 221 | 237 |
|
Also available in: Unified diff