========
LinuxDoc
========
The LinuxDoc library contains Sphinx-doc extensions and command line tools to
extract documentation from C/C++ source file comments. Even if this project
started in context of the Linux-Kernel documentation, you can use these
extensions in common Sphinx-doc projects.
Install
=======
`Install LinuxDoc <https://return42.github.io/linuxdoc/install.html>`__ using `pip
<https://pip.pypa.io/en/stable/getting-started/>`__:
.. code-block:: text
pip install --user -U linuxdoc
Links
=====
- Documentation: https://return42.github.io/linuxdoc
- Releases: https://pypi.org/project/linuxdoc/
- Code: https://github.com/return42/linuxdoc
- Issue tracker: https://github.com/return42/linuxdoc/issues
============ ===============================================
package: linuxdoc (20240924)
copyright: 2024 Markus Heiser
e-mail: markus.heiser@darmarIT.de
license: AGPLv3+
============ ===============================================
Raw data
{
"_id": null,
"home_page": "https://github.com/return42/linuxdoc",
"name": "linuxdoc",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "sphinx extension doc source code comments kernel-doc linux",
"author": "Markus Heiser",
"author_email": "markus.heiser@darmarIT.de",
"download_url": "https://files.pythonhosted.org/packages/62/73/5c216216888079359734c7ecb02339c478383c097d1aa3297f89988b55a5/linuxdoc-20240924.tar.gz",
"platform": null,
"description": "========\nLinuxDoc\n========\n\nThe LinuxDoc library contains Sphinx-doc extensions and command line tools to\nextract documentation from C/C++ source file comments. Even if this project\nstarted in context of the Linux-Kernel documentation, you can use these\nextensions in common Sphinx-doc projects.\n\n\nInstall\n=======\n\n`Install LinuxDoc <https://return42.github.io/linuxdoc/install.html>`__ using `pip\n<https://pip.pypa.io/en/stable/getting-started/>`__:\n\n.. code-block:: text\n\n pip install --user -U linuxdoc\n\n\nLinks\n=====\n\n- Documentation: https://return42.github.io/linuxdoc\n- Releases: https://pypi.org/project/linuxdoc/\n- Code: https://github.com/return42/linuxdoc\n- Issue tracker: https://github.com/return42/linuxdoc/issues\n\n\n============ ===============================================\npackage: linuxdoc (20240924)\ncopyright: 2024 Markus Heiser\ne-mail: markus.heiser@darmarIT.de\nlicense: AGPLv3+\n============ ===============================================\n\n",
"bugtrack_url": null,
"license": "AGPLv3+",
"summary": "Sphinx-doc extensions & tools to extract documentation from C/C++ source file comments.",
"version": "20240924",
"project_urls": {
"Changelog": "https://github.com/return42/linuxdoc/blob/master/CHANGELOG",
"Code": "https://github.com/return42/linuxdoc",
"Documentation": "https://return42.github.io/linuxdoc",
"Homepage": "https://github.com/return42/linuxdoc",
"Issue tracker": "https://github.com/return42/linuxdoc/issues"
},
"split_keywords": [
"sphinx",
"extension",
"doc",
"source",
"code",
"comments",
"kernel-doc",
"linux"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "62735c216216888079359734c7ecb02339c478383c097d1aa3297f89988b55a5",
"md5": "2322825c117556d2aed17049493574a5",
"sha256": "e72256ce7a9654d22bf53919f95842b8c51ebe59ebd1b52ef92be2f4ad948d25"
},
"downloads": -1,
"filename": "linuxdoc-20240924.tar.gz",
"has_sig": false,
"md5_digest": "2322825c117556d2aed17049493574a5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 65042,
"upload_time": "2024-09-24T10:59:58",
"upload_time_iso_8601": "2024-09-24T10:59:58.392011Z",
"url": "https://files.pythonhosted.org/packages/62/73/5c216216888079359734c7ecb02339c478383c097d1aa3297f89988b55a5/linuxdoc-20240924.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-24 10:59:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "return42",
"github_project": "linuxdoc",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "fspath",
"specs": []
},
{
"name": "setuptools",
"specs": []
},
{
"name": "docutils",
"specs": []
},
{
"name": "sphinx",
"specs": []
}
],
"tox": true,
"lcname": "linuxdoc"
}
JSON
