| Name | sphinx-apipages JSON |
| Version |
0.1.3
JSON |
| download |
| home_page | |
| Summary | Sphinx extension for API documentation with sub-pages |
| upload_time | 2024-01-29 15:32:11 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | |
| license | MIT License Copyright (c) 2023- audEERING GmbH and Contributors Authors: Hagen Wierstorf Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
documentation
sphinx
autosummary
autodoc
split
api
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
===============
sphinx-apipages
===============
**sphinx-apipages** is a sphinx_ extension
for API documentation.
It uses the autosummary_ and autodoc_ directives,
and creates sub-pages
for each function and class.
Have a look at the installation_ and usage_ instructions.
.. _autodoc: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html
.. _autosummary: https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html
.. _installation: https://audeering.github.io/sphinx-apipages/install.html
.. _sphinx: https://www.sphinx-doc.org/en/master/
.. _usage: https://audeering.github.io/sphinx-apipages/usage.html
Raw data
{
"_id": null,
"home_page": "",
"name": "sphinx-apipages",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "documentation,sphinx,autosummary,autodoc,split,api",
"author": "",
"author_email": "Hagen Wierstorf <hwierstorf@audeering.com>",
"download_url": "https://files.pythonhosted.org/packages/6e/c5/7dfd4a015a846c54165f4107540a68d6b5d7eb3430abfb117d2680043898/sphinx-apipages-0.1.3.tar.gz",
"platform": null,
"description": "===============\nsphinx-apipages\n===============\n\n**sphinx-apipages** is a sphinx_ extension\nfor API documentation.\nIt uses the autosummary_ and autodoc_ directives,\nand creates sub-pages\nfor each function and class.\n\nHave a look at the installation_ and usage_ instructions.\n\n\n.. _autodoc: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html\n.. _autosummary: https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html\n.. _installation: https://audeering.github.io/sphinx-apipages/install.html\n.. _sphinx: https://www.sphinx-doc.org/en/master/\n.. _usage: https://audeering.github.io/sphinx-apipages/usage.html\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023- audEERING GmbH and Contributors Authors: Hagen Wierstorf Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Sphinx extension for API documentation with sub-pages",
"version": "0.1.3",
"project_urls": {
"documentation": "https://audeering.github.io/audb/",
"repository": "https://github.com/audeering/sphinx-apipages/"
},
"split_keywords": [
"documentation",
"sphinx",
"autosummary",
"autodoc",
"split",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "79c79c7aafc017dd2e284b521ce57e2dd00b970027f9bdcf8b41f3159051f18b",
"md5": "37df2322f7a1719634d73df0a74bb68d",
"sha256": "bf627e2e5ab73be6ae362f52ba1b6c43ace5980bdfd146a2815e4b3012ed3809"
},
"downloads": -1,
"filename": "sphinx_apipages-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "37df2322f7a1719634d73df0a74bb68d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9135,
"upload_time": "2024-01-29T15:32:09",
"upload_time_iso_8601": "2024-01-29T15:32:09.779469Z",
"url": "https://files.pythonhosted.org/packages/79/c7/9c7aafc017dd2e284b521ce57e2dd00b970027f9bdcf8b41f3159051f18b/sphinx_apipages-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6ec57dfd4a015a846c54165f4107540a68d6b5d7eb3430abfb117d2680043898",
"md5": "8e31d7e4f50a23b901c9ef9da1dc997f",
"sha256": "94bf6e48dabda9a299311e1a2a2dec24aa608236826aec52f492b4276a227f0f"
},
"downloads": -1,
"filename": "sphinx-apipages-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "8e31d7e4f50a23b901c9ef9da1dc997f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11584,
"upload_time": "2024-01-29T15:32:11",
"upload_time_iso_8601": "2024-01-29T15:32:11.485477Z",
"url": "https://files.pythonhosted.org/packages/6e/c5/7dfd4a015a846c54165f4107540a68d6b5d7eb3430abfb117d2680043898/sphinx-apipages-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-29 15:32:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "audeering",
"github_project": "sphinx-apipages",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "sphinx-apipages"
}
