| Name | apibook JSON |
| Version |
0.1.2
JSON |
| download |
| home_page | None |
| Summary | API documentation generator for MdBook |
| upload_time | 2024-04-24 09:45:25 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2022 Tom Solberg 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 |
mdbook
apidoc
documentation
markdown
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# `python-apibook`
[](https://tgolsson.github.io/python-apibook/)[](https://pypi.org/project/python-apibook)
Are you tired of fighting Sphinx to get it to do what you want? Do you want to write your documentation in Markdown? Do you want to easily combine prose with API docs? Then this is the tool for you!
`python-apibook` uses the AST module to parse your code and generate API documentation in Markdown format, and can easily be merged into your existing `mdbook` `SUMMARY.md` file.
## Installation
```bash
pip install git+https://github.com/tgolsson/python-apibook.git
```
## Usage
To see the available options, run:
```bash
python -m apibook.cli --help
```
To generate API documentation for a package, run:
```bash
python-apibook my_package doc/src --summary-template-file doc/SUMMARY.tmpl
```
This will generate all markdown sources and a `SUMMARY.md` file in the `doc/src` directory, which you can include in your `mdbook` project. _Hint_: Combine this with `mdbook serve doc` to see the results in real-time.
Raw data
{
"_id": null,
"home_page": null,
"name": "apibook",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "mdbook apidoc documentation markdown",
"author": null,
"author_email": "Tom Solberg <me@sbg.dev>",
"download_url": "https://files.pythonhosted.org/packages/c9/50/6c5e054186680ed613ff073a941152fb233a853c38f0276363cc8c90f277/apibook-0.1.2.tar.gz",
"platform": null,
"description": "# `python-apibook`\n\n[](https://tgolsson.github.io/python-apibook/)[](https://pypi.org/project/python-apibook)\n\nAre you tired of fighting Sphinx to get it to do what you want? Do you want to write your documentation in Markdown? Do you want to easily combine prose with API docs? Then this is the tool for you!\n\n`python-apibook` uses the AST module to parse your code and generate API documentation in Markdown format, and can easily be merged into your existing `mdbook` `SUMMARY.md` file.\n\n## Installation\n\n```bash\npip install git+https://github.com/tgolsson/python-apibook.git\n```\n\n## Usage\n\nTo see the available options, run:\n```bash\npython -m apibook.cli --help\n```\n\nTo generate API documentation for a package, run:\n```bash\npython-apibook my_package doc/src --summary-template-file doc/SUMMARY.tmpl\n```\n\nThis will generate all markdown sources and a `SUMMARY.md` file in the `doc/src` directory, which you can include in your `mdbook` project. _Hint_: Combine this with `mdbook serve doc` to see the results in real-time.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2022 Tom Solberg 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": "API documentation generator for MdBook",
"version": "0.1.2",
"project_urls": {
"Changelog": "https://github.com/tgolsson/python-apibook/tree/main/CHANGELOG.md",
"Repository": "https://github.com/tgolsson/python-apibook"
},
"split_keywords": [
"mdbook",
"apidoc",
"documentation",
"markdown"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "09b0bdce6e7ff7a1a610bde1f60a158b9715134ecdcacdd6e9530da4213272b1",
"md5": "d53e8f3268fa4481d214289aaf449080",
"sha256": "da1fcaf0d95dd59b122d9ba20338fadcf04455a2924100271696f5d818d760a5"
},
"downloads": -1,
"filename": "apibook-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d53e8f3268fa4481d214289aaf449080",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 11417,
"upload_time": "2024-04-24T09:45:24",
"upload_time_iso_8601": "2024-04-24T09:45:24.713264Z",
"url": "https://files.pythonhosted.org/packages/09/b0/bdce6e7ff7a1a610bde1f60a158b9715134ecdcacdd6e9530da4213272b1/apibook-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c9506c5e054186680ed613ff073a941152fb233a853c38f0276363cc8c90f277",
"md5": "0e8f090ffc9e1f1e4a445c80452b00f2",
"sha256": "56fa204d28923fd21bfc564c94a0c34956f3d80ed03859f50007587abeb6c6f8"
},
"downloads": -1,
"filename": "apibook-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "0e8f090ffc9e1f1e4a445c80452b00f2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 10146,
"upload_time": "2024-04-24T09:45:25",
"upload_time_iso_8601": "2024-04-24T09:45:25.926063Z",
"url": "https://files.pythonhosted.org/packages/c9/50/6c5e054186680ed613ff073a941152fb233a853c38f0276363cc8c90f277/apibook-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-24 09:45:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tgolsson",
"github_project": "python-apibook",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "apibook"
}
