| Name | sphinxygen JSON |
| Version |
1.0.10
JSON |
| download |
| home_page | None |
| Summary | A script to generate Sphinx ReST from Doxygen XML |
| upload_time | 2025-01-18 22:35:09 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | ISC |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Sphinxygen
==========
Sphinxygen is a Python module/script that generates [Sphinx][] markup to
describe a C API, from an XML description extracted by [Doxygen][].
Installation
------------
Sphinxygen can be installed from [PyPI][] with [pip][]:
pip3 install sphinxygen
Alternatively, it can be installed locally from this source tree:
pip3 install .
Usage
-----
Sphinxygen is mainly intended for use on the command line or in scripts. After
installation, `sphinxygen` should be available to be run on an `index.xml`
file, for example:
sphinxygen xml/index.xml sphinx_input
See the output of `sphinxygen --help` for details.
A `sphinxygen` module is also installed for programmatic use within Python,
typically via `sphinxygen.run()` which is a straightforward reflection of the
command-line options. The command-line interface is also available as
`sphinxygen.main()`.
A minimal [meson][] build definition is included for using Sphinxygen as a
subproject. It is not intended for installation, or any use other than
wrapping `sphinxygen.py` to ensure that it's available from meson.
-- David Robillard <d@drobilla.net>
[Sphinx]: https://www.sphinx-doc.org/
[Doxygen]: https://doxygen.nl/
[pip]: https://pypi.org/project/pip/
[PyPI]: https://pypi.org/
[meson]: https://mesonbuild.com/
Raw data
{
"_id": null,
"home_page": null,
"name": "sphinxygen",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "David Robillard <d@drobilla.net>",
"download_url": "https://files.pythonhosted.org/packages/2a/f3/3b587ebdc14b2cbcc83dc7b671bfba18920fb5f0bcc9e859a8eea164ffca/sphinxygen-1.0.10.tar.gz",
"platform": null,
"description": "Sphinxygen\n==========\n\nSphinxygen is a Python module/script that generates [Sphinx][] markup to\ndescribe a C API, from an XML description extracted by [Doxygen][].\n\nInstallation\n------------\n\nSphinxygen can be installed from [PyPI][] with [pip][]:\n\n pip3 install sphinxygen\n\nAlternatively, it can be installed locally from this source tree:\n\n pip3 install .\n\nUsage\n-----\n\nSphinxygen is mainly intended for use on the command line or in scripts. After\ninstallation, `sphinxygen` should be available to be run on an `index.xml`\nfile, for example:\n\n sphinxygen xml/index.xml sphinx_input\n\nSee the output of `sphinxygen --help` for details.\n\nA `sphinxygen` module is also installed for programmatic use within Python,\ntypically via `sphinxygen.run()` which is a straightforward reflection of the\ncommand-line options. The command-line interface is also available as\n`sphinxygen.main()`.\n\nA minimal [meson][] build definition is included for using Sphinxygen as a\nsubproject. It is not intended for installation, or any use other than\nwrapping `sphinxygen.py` to ensure that it's available from meson.\n\n -- David Robillard <d@drobilla.net>\n\n[Sphinx]: https://www.sphinx-doc.org/\n[Doxygen]: https://doxygen.nl/\n[pip]: https://pypi.org/project/pip/\n[PyPI]: https://pypi.org/\n[meson]: https://mesonbuild.com/\n",
"bugtrack_url": null,
"license": "ISC",
"summary": "A script to generate Sphinx ReST from Doxygen XML",
"version": "1.0.10",
"project_urls": {
"Homepage": "https://gitlab.com/drobilla/sphinxygen"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2af33b587ebdc14b2cbcc83dc7b671bfba18920fb5f0bcc9e859a8eea164ffca",
"md5": "29d15a4a2684abac843918d110f09b77",
"sha256": "4b5eeb1ff47d43ee1ddae9327c2b49bab1e49363538c569bc544705284f3695d"
},
"downloads": -1,
"filename": "sphinxygen-1.0.10.tar.gz",
"has_sig": false,
"md5_digest": "29d15a4a2684abac843918d110f09b77",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 14445,
"upload_time": "2025-01-18T22:35:09",
"upload_time_iso_8601": "2025-01-18T22:35:09.842331Z",
"url": "https://files.pythonhosted.org/packages/2a/f3/3b587ebdc14b2cbcc83dc7b671bfba18920fb5f0bcc9e859a8eea164ffca/sphinxygen-1.0.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-18 22:35:09",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "drobilla",
"gitlab_project": "sphinxygen",
"lcname": "sphinxygen"
}
