mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Fix some XXXes.
This commit is contained in:
parent
538886ab94
commit
1bce0d7e6a
@ -298,7 +298,9 @@ The special files are located in the root output directory. They are:
|
||||
``environment.pickle``
|
||||
The build environment. This is always a pickle file, independent of the
|
||||
builder and a copy of the environment that was used when the builder was
|
||||
started. (XXX: document common members)
|
||||
started.
|
||||
|
||||
Unlike the other pickle files this pickle file requires that the sphinx
|
||||
module is available on unpickling.
|
||||
.. todo:: Document common members.
|
||||
|
||||
Unlike the other pickle files this pickle file requires that the ``sphinx``
|
||||
package is available on unpickling.
|
||||
|
@ -340,5 +340,3 @@ There are some problems one commonly runs into while authoring reST documents:
|
||||
|
||||
* **No nested inline markup:** Something like ``*see :func:`foo`*`` is not
|
||||
possible.
|
||||
|
||||
.. XXX more?
|
||||
|
@ -51,8 +51,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_]+)'}
|
||||
coverage_c_regexes = {'function': r'^PyAPI_FUNC\(.*\)\s+([^_][\w_]+)'}
|
||||
|
||||
autosummary_generate = ['autosummary']
|
||||
|
||||
|
@ -36,8 +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 undoc_c.values()[0] == [('function', 'Py_SphinxTest')]
|
||||
|
||||
assert 'test_autodoc' in undoc_py
|
||||
assert 'funcs' in undoc_py['test_autodoc']
|
||||
|
@ -273,7 +273,7 @@ ignore-docstrings=yes
|
||||
|
||||
|
||||
# checks for:
|
||||
# * warning notes in the code like FIXME, XXX
|
||||
# * warning notes in the code
|
||||
# * PEP 263: source code with non ascii character but no encoding declaration
|
||||
#
|
||||
[MISCELLANEOUS]
|
||||
|
Loading…
Reference in New Issue
Block a user