blob: 0fdd9fecbe911ed8540c1b2c79e6ba605a8a0121 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
|
:mod:`sphinx.ext.oldcmarkup` -- Compatibility extension for old C markup
========================================================================
.. module:: sphinx.ext.oldcmarkup
:synopsis: Allow further use of the pre-domain C markup
.. moduleauthor:: Georg Brandl
.. versionadded:: 1.0
This extension is a transition helper for projects that used the old
(pre-domain) C markup, i.e. the directives like ``cfunction`` and roles like
``cfunc``. Since the introduction of domains, they must be called by their
fully-qualified name (``c:function`` and ``c:func``, respectively) or, with the
default domain set to ``c``, by their new name (``function`` and ``func``).
(See :ref:`c-domain` for the details.)
If you activate this extension, it will register the old names, and you can
use them like before Sphinx 1.0. The directives are:
- ``cfunction``
- ``cmember``
- ``cmacro``
- ``ctype``
- ``cvar``
The roles are:
- ``cdata``
- ``cfunc``
- ``cmacro``
- ``ctype``
However, it is advised to migrate to the new markup -- this extension is a
compatibility convenience and will disappear in a future version of Sphinx.
|
