diff options
| -rw-r--r-- | doc/markup/desc.rst | 2 | ||||
| -rw-r--r-- | sphinx/writers/latex.py | 1 | ||||
| -rw-r--r-- | tests/root/conf.py | 1 | ||||
| -rw-r--r-- | tests/test_coverage.py | 1 |
4 files changed, 5 insertions, 0 deletions
diff --git a/doc/markup/desc.rst b/doc/markup/desc.rst index 4cfba05fd..058b5137d 100644 --- a/doc/markup/desc.rst +++ b/doc/markup/desc.rst @@ -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.:: diff --git a/sphinx/writers/latex.py b/sphinx/writers/latex.py index 7e796270c..d21cc89d7 100644 --- a/sphinx/writers/latex.py +++ b/sphinx/writers/latex.py @@ -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', diff --git a/tests/root/conf.py b/tests/root/conf.py index a82602fff..d268ae3a5 100644 --- a/tests/root/conf.py +++ b/tests/root/conf.py @@ -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'] diff --git a/tests/test_coverage.py b/tests/test_coverage.py index 369788a19..bc59a8152 100644 --- a/tests/test_coverage.py +++ b/tests/test_coverage.py @@ -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 |