1SPHINXYGEN(1)             BSD General Commands Manual            SPHINXYGEN(1)
2

NAME

4     sphinxygen — generate Sphinx ReST from Doxygen XML
5

SYNOPSIS

7     sphinxygen [-hf] [-l lang] [--language lang] index_xml output_dir
8

DESCRIPTION

10     sphinxygen is a script that reads an XML description of a C API extracted
11     by Doxygen, and outputs Sphinx markup that describes the API.  The
12     index_xml argument must be the path to a index.xml file in a directory
13     generated by Doxygen.  The output will be written as several ReST files
14     in output_dir, typically one for each documentation group.
15
16     The options are as follows:
17
18     -f, --force
19          For overwriting of any output files that already exist.
20
21     -h, --help
22          Print the command line options and exit.
23
24     -l lang, --language lang
25          Sphinx domain to use.  Only the “c” domain is currently well sup‐
26          ported.
27
28     -V, --version
29          Print the version and exit.
30

EXIT STATUS

32     sphinxygen exits with a status of 0, or non-zero if an error occurred.
33

SEE ALSO

35     doxygen(1)
36

AUTHORS

38     sphinxygen was written by David Robillard d@drobilla.net.
39
40Sphinxygen 1.0.2                 Feb 27, 2023                 Sphinxygen 1.0.2
Impressum