mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Add some XXX comments to places where work is needed.
This commit is contained in:
parent
ec5e5de95b
commit
efa4678cfd
@ -92,6 +92,8 @@ index entries more informative.
|
||||
|
||||
The directives are:
|
||||
|
||||
.. XXX update this
|
||||
|
||||
.. directive:: .. cfunction:: type name(signature)
|
||||
|
||||
Describes a C function. The signature should be given as in C, e.g.::
|
||||
|
@ -428,6 +428,7 @@ class LaTeXTranslator(nodes.NodeVisitor):
|
||||
def depart_subtitle(self, node):
|
||||
self.body.append(self.context.pop())
|
||||
|
||||
# XXX update this
|
||||
desc_map = {
|
||||
'function' : 'funcdesc',
|
||||
'class': 'classdesc',
|
||||
|
@ -50,6 +50,7 @@ latex_additional_files = ['svgimg.svg']
|
||||
value_from_conf_py = 84
|
||||
|
||||
coverage_c_path = ['special/*.h']
|
||||
# XXX cfunction?
|
||||
coverage_c_regexes = {'cfunction': r'^PyAPI_FUNC\(.*\)\s+([^_][\w_]+)'}
|
||||
|
||||
autosummary_generate = ['autosummary']
|
||||
|
@ -36,6 +36,7 @@ def test_build(app):
|
||||
undoc_py, undoc_c = pickle.loads((app.outdir / 'undoc.pickle').text())
|
||||
assert len(undoc_c) == 1
|
||||
# the key is the full path to the header file, which isn't testable
|
||||
# XXX this should fail right now
|
||||
assert undoc_c.values()[0] == [('cfunction', 'Py_SphinxTest')]
|
||||
|
||||
assert 'test_autodoc' in undoc_py
|
||||
|
Loading…
Reference in New Issue
Block a user