IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add some XXX comments to places where work is needed.

Browse Source
This commit is contained in:
Georg Brandl 2009-09-08 12:07:11 +02:00
parent ec5e5de95b
commit efa4678cfd
4 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/markup/desc.rst
View File

@ -92,6 +92,8 @@ index entries more informative.
The directives are: The directives are:
.. XXX update this
.. directive:: .. cfunction:: type name(signature) .. directive:: .. cfunction:: type name(signature)
Describes a C function. The signature should be given as in C, e.g.:: Describes a C function. The signature should be given as in C, e.g.::

1
sphinx/writers/latex.py
View File

@ -428,6 +428,7 @@ class LaTeXTranslator(nodes.NodeVisitor):
def depart_subtitle(self, node): def depart_subtitle(self, node):
self.body.append(self.context.pop()) self.body.append(self.context.pop())
# XXX update this
desc_map = { desc_map = {
'function' : 'funcdesc', 'function' : 'funcdesc',
'class': 'classdesc', 'class': 'classdesc',

1
tests/root/conf.py
View File

@ -50,6 +50,7 @@ latex_additional_files = ['svgimg.svg']
value_from_conf_py = 84 value_from_conf_py = 84
coverage_c_path = ['special/*.h'] coverage_c_path = ['special/*.h']
# XXX cfunction?
coverage_c_regexes = {'cfunction': r'^PyAPI_FUNC\(.*\)\s+([^_][\w_]+)'} coverage_c_regexes = {'cfunction': r'^PyAPI_FUNC\(.*\)\s+([^_][\w_]+)'}
autosummary_generate = ['autosummary'] autosummary_generate = ['autosummary']

1
tests/test_coverage.py
View File

@ -36,6 +36,7 @@ def test_build(app):
undoc_py, undoc_c = pickle.loads((app.outdir / 'undoc.pickle').text()) undoc_py, undoc_c = pickle.loads((app.outdir / 'undoc.pickle').text())
assert len(undoc_c) == 1 assert len(undoc_c) == 1
# the key is the full path to the header file, which isn't testable # 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 undoc_c.values()[0] == [('cfunction', 'Py_SphinxTest')]
assert 'test_autodoc' in undoc_py assert 'test_autodoc' in undoc_py