| Name | sphinx-c-autodoc JSON |
| Version |
1.4.0
JSON |
| download |
| home_page | None |
| Summary | A sphinx autodoc extension for c modules |
| upload_time | 2024-10-16 19:18:49 |
| maintainer | None |
| docs_url | None |
| author | Nick |
| requires_python | >=3.9 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
sphinx-c-autodoc
================
|build-status| |coverage| |black| |docs|
Dual-licensed under MIT or the `UNLICENSE <https://unlicense.org>`_.
.. inclusion_begin
A basic attempt at extending `Sphinx`_ and `autodoc`_ to work with C files.
The idea is to add support for similar directives that `autodoc`_ provides. i.e.
A function in ``my_c_file.c``:
.. code-block:: c
/**
* A simple function that adds.
*
* @param a: The initial value
* @param b: The value to add to `a`
*
* @returns The sum of `a` and `b`.
*
*/
int my_adding_function(int a, int b) {
return a + b;
}
Could be referenced in documentation as:
.. code-block:: rst
.. autocfunction:: my_c_file.c::my_adding_function
With the resulting documentation output of:
.. Note this isn't using the c:function directive because that doesn't work on
pypi
int my_adding_function(int a, int b)
A simple function that adds.
:Parameters:
* **a** - The initial value
* **b** - The value to add to `a`
:Returns: The sum of `a` and `b`
.. _autodoc: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html
.. _Sphinx: https://www.sphinx-doc.org/en/master/index.html
Requires
--------
* `clang <https://pypi.org/project/clang/>`_
* `beautifulsoup4 <https://www.crummy.com/software/BeautifulSoup/bs4/doc/>`_
Similar Tools
-------------
* `hawkmoth <https://github.com/jnikula/hawkmoth>`_ a sphinx extension that
which will document all of a C file. It supports being able to regex list
files and have those files be documented.
* `breathe <https://github.com/michaeljones/breathe>`_ A doxygen output to
sphinx tool.
.. |build-status| image:: https://github.com/speedyleion/sphinx-c-autodoc/actions/workflows/ci.yml/badge.svg
:alt: Build Status
:target: https://github.com/speedyleion/sphinx-c-autodoc/actions/workflows/ci.yml
.. |coverage| image:: https://codecov.io/gh/speedyleion/sphinx-c-autodoc/branch/main/graph/badge.svg
:alt: Coverage
:target: https://codecov.io/gh/speedyleion/sphinx-c-autodoc
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:alt: Code Style
:target: https://github.com/psf/black
.. |docs| image:: https://readthedocs.org/projects/sphinx-c-autodoc/badge/?version=latest
:alt: Documentation Status
:target: https://sphinx-c-autodoc.readthedocs.io/en/latest/?badge=latest
.. inclusion_end
Full Documentation
------------------
The complete documentation can be found at https://sphinx-c-autodoc.readthedocs.io/en/latest
Raw data
{
"_id": null,
"home_page": null,
"name": "sphinx-c-autodoc",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Nick",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/41/f3/727fa7949b9f226a1f0b18c17d76bd24f1cae89218c4ec2789ca9766e20a/sphinx_c_autodoc-1.4.0.tar.gz",
"platform": null,
"description": "sphinx-c-autodoc\n================\n\n|build-status| |coverage| |black| |docs|\n\nDual-licensed under MIT or the `UNLICENSE <https://unlicense.org>`_.\n\n.. inclusion_begin\n\nA basic attempt at extending `Sphinx`_ and `autodoc`_ to work with C files.\n\nThe idea is to add support for similar directives that `autodoc`_ provides. i.e.\n\nA function in ``my_c_file.c``:\n\n.. code-block:: c\n\n /**\n * A simple function that adds.\n *\n * @param a: The initial value\n * @param b: The value to add to `a`\n *\n * @returns The sum of `a` and `b`.\n *\n */\n int my_adding_function(int a, int b) {\n return a + b;\n }\n\nCould be referenced in documentation as:\n\n.. code-block:: rst\n\n .. autocfunction:: my_c_file.c::my_adding_function\n\nWith the resulting documentation output of:\n\n.. Note this isn't using the c:function directive because that doesn't work on\n pypi\n\nint my_adding_function(int a, int b) \n A simple function that adds.\n\n :Parameters:\n * **a** - The initial value\n * **b** - The value to add to `a`\n\n :Returns: The sum of `a` and `b`\n\n.. _autodoc: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html\n.. _Sphinx: https://www.sphinx-doc.org/en/master/index.html\n\nRequires\n--------\n\n* `clang <https://pypi.org/project/clang/>`_\n* `beautifulsoup4 <https://www.crummy.com/software/BeautifulSoup/bs4/doc/>`_\n\nSimilar Tools\n-------------\n\n* `hawkmoth <https://github.com/jnikula/hawkmoth>`_ a sphinx extension that\n which will document all of a C file. It supports being able to regex list\n files and have those files be documented.\n* `breathe <https://github.com/michaeljones/breathe>`_ A doxygen output to\n sphinx tool.\n\n.. |build-status| image:: https://github.com/speedyleion/sphinx-c-autodoc/actions/workflows/ci.yml/badge.svg\n :alt: Build Status\n :target: https://github.com/speedyleion/sphinx-c-autodoc/actions/workflows/ci.yml\n\n.. |coverage| image:: https://codecov.io/gh/speedyleion/sphinx-c-autodoc/branch/main/graph/badge.svg\n :alt: Coverage\n :target: https://codecov.io/gh/speedyleion/sphinx-c-autodoc\n\n.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :alt: Code Style\n :target: https://github.com/psf/black\n\n.. |docs| image:: https://readthedocs.org/projects/sphinx-c-autodoc/badge/?version=latest\n :alt: Documentation Status\n :target: https://sphinx-c-autodoc.readthedocs.io/en/latest/?badge=latest\n\n.. inclusion_end\n\nFull Documentation\n------------------\n\nThe complete documentation can be found at https://sphinx-c-autodoc.readthedocs.io/en/latest\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A sphinx autodoc extension for c modules",
"version": "1.4.0",
"project_urls": {
"documentation": "https://sphinx-c-autodoc.readthedocs.io/en/latest/",
"repository": "https://github.com/speedyleion/sphinx-c-autodoc"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f7a0ff3beb6a7e42b50e4aa61ea436bd853f56c674e5ab39431fb268bffb99ee",
"md5": "cb111aa3198313d244fb4e22ae812429",
"sha256": "a8f8124054971808d96e95e3bb0916f8bd12fb41036c5a5977a522064400aa76"
},
"downloads": -1,
"filename": "sphinx_c_autodoc-1.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cb111aa3198313d244fb4e22ae812429",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 34221,
"upload_time": "2024-10-16T19:18:47",
"upload_time_iso_8601": "2024-10-16T19:18:47.599624Z",
"url": "https://files.pythonhosted.org/packages/f7/a0/ff3beb6a7e42b50e4aa61ea436bd853f56c674e5ab39431fb268bffb99ee/sphinx_c_autodoc-1.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "41f3727fa7949b9f226a1f0b18c17d76bd24f1cae89218c4ec2789ca9766e20a",
"md5": "e2d9644d6992c032cd62fdbbc2f03b52",
"sha256": "e14047b87848f7877616a008ad0b26e920a8fd77945d6ff1f808499041dffa83"
},
"downloads": -1,
"filename": "sphinx_c_autodoc-1.4.0.tar.gz",
"has_sig": false,
"md5_digest": "e2d9644d6992c032cd62fdbbc2f03b52",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 30735,
"upload_time": "2024-10-16T19:18:49",
"upload_time_iso_8601": "2024-10-16T19:18:49.141709Z",
"url": "https://files.pythonhosted.org/packages/41/f3/727fa7949b9f226a1f0b18c17d76bd24f1cae89218c4ec2789ca9766e20a/sphinx_c_autodoc-1.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-16 19:18:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "speedyleion",
"github_project": "sphinx-c-autodoc",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "sphinx-c-autodoc"
}
