| Name | sophia-doc JSON |
| Version |
0.1.8
JSON |
| download |
| home_page | None |
| Summary | A python package to automatically generate API documents for Python modules. |
| upload_time | 2024-03-26 14:35:59 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT |
| keywords |
sophia-doc
documentation
doc
pydoc
markdown
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Sophia-doc
**A python package to automatically generate API documents for Python modules.**
## Introduction
Sophia is a python package to automatically generate API documents for Python modules.
It's a lot like sphinx, but it only focuses on generating markdown documentation.
It does not support PEP 224 attribute docstring, because the PEP was rejected, and have to use ast module to support it, which brings additional complexity to this project.
## Install
```sh
pip install sophia-doc
```
## Quickstart
```sh
sophia_doc "sophia_doc" -o ./doc
```
## Usage
Command line:
```txt
usage: sophia_doc [-h] [-o OUTPUT_DIR] [--docstring-style DOCSTRING_STYLE] [--anchor-extend | --no-anchor-extend] [--overwrite | --no-overwrite]
[--exclude-module-name | --no-exclude-module-name]
module
Sophia_doc is a python package to automatically generate API documents for Python modules
positional arguments:
module Python module names.
options:
-h, --help show this help message and exit
-o OUTPUT_DIR, --output-dir OUTPUT_DIR
The directory to write document. (default: doc)
--docstring-style DOCSTRING_STYLE
Docstring style the python module used. (default: auto)
--anchor-extend, --no-anchor-extend
Add anchor to markdown title. (default: False)
--overwrite, --no-overwrite
Overwrite any file in output directory. (default: False)
--exclude-module-name, --no-exclude-module-name
Write file to path which exclude module name. (default: False)
```
## License
MIT © st1020
Raw data
{
"_id": null,
"home_page": null,
"name": "sophia-doc",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "sophia-doc documentation doc pydoc markdown",
"author": null,
"author_email": "st1020 <me@st1020.com>",
"download_url": "https://files.pythonhosted.org/packages/43/31/0e9647a17c4123a8ee016566dc4acc1858773431ebe71608adde81dd0ffc/sophia_doc-0.1.8.tar.gz",
"platform": null,
"description": "# Sophia-doc\n\n**A python package to automatically generate API documents for Python modules.**\n\n## Introduction\n\nSophia is a python package to automatically generate API documents for Python modules.\n\nIt's a lot like sphinx, but it only focuses on generating markdown documentation.\n\nIt does not support PEP 224 attribute docstring, because the PEP was rejected, and have to use ast module to support it, which brings additional complexity to this project.\n\n## Install\n\n```sh\npip install sophia-doc\n```\n\n## Quickstart\n\n```sh\nsophia_doc \"sophia_doc\" -o ./doc\n```\n\n## Usage\n\nCommand line:\n\n```txt\nusage: sophia_doc [-h] [-o OUTPUT_DIR] [--docstring-style DOCSTRING_STYLE] [--anchor-extend | --no-anchor-extend] [--overwrite | --no-overwrite]\n [--exclude-module-name | --no-exclude-module-name]\n module\n\nSophia_doc is a python package to automatically generate API documents for Python modules\n\npositional arguments:\n module Python module names.\n\noptions:\n -h, --help show this help message and exit\n -o OUTPUT_DIR, --output-dir OUTPUT_DIR\n The directory to write document. (default: doc)\n --docstring-style DOCSTRING_STYLE\n Docstring style the python module used. (default: auto)\n --anchor-extend, --no-anchor-extend\n Add anchor to markdown title. (default: False)\n --overwrite, --no-overwrite\n Overwrite any file in output directory. (default: False)\n --exclude-module-name, --no-exclude-module-name\n Write file to path which exclude module name. (default: False)\n```\n\n## License\n\nMIT \u00a9 st1020\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A python package to automatically generate API documents for Python modules.",
"version": "0.1.8",
"project_urls": {
"Homepage": "https://github.com/st1020/sophia-doc",
"Source": "https://github.com/st1020/sophia-doc"
},
"split_keywords": [
"sophia-doc",
"documentation",
"doc",
"pydoc",
"markdown"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "61646a86510ebf477d35d07865a74f50ff0e786551aed4dac1e0bfa9f0a6606c",
"md5": "4c265185c83f7b28b3cf1b9fa0ceb7c3",
"sha256": "16a82f6dc5a7110f9a8aa03adfb012b2d67c2d2a392fda0fe5c23247de9afcd2"
},
"downloads": -1,
"filename": "sophia_doc-0.1.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4c265185c83f7b28b3cf1b9fa0ceb7c3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 14686,
"upload_time": "2024-03-26T14:35:56",
"upload_time_iso_8601": "2024-03-26T14:35:56.865332Z",
"url": "https://files.pythonhosted.org/packages/61/64/6a86510ebf477d35d07865a74f50ff0e786551aed4dac1e0bfa9f0a6606c/sophia_doc-0.1.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "43310e9647a17c4123a8ee016566dc4acc1858773431ebe71608adde81dd0ffc",
"md5": "c3ec2e1f4307afa77e1944c02ed1b3fa",
"sha256": "f3b3c7f2950044c5fe1a1ad484e103f49120458528106551ea75410b316d8887"
},
"downloads": -1,
"filename": "sophia_doc-0.1.8.tar.gz",
"has_sig": false,
"md5_digest": "c3ec2e1f4307afa77e1944c02ed1b3fa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 14022,
"upload_time": "2024-03-26T14:35:59",
"upload_time_iso_8601": "2024-03-26T14:35:59.656253Z",
"url": "https://files.pythonhosted.org/packages/43/31/0e9647a17c4123a8ee016566dc4acc1858773431ebe71608adde81dd0ffc/sophia_doc-0.1.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-26 14:35:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "st1020",
"github_project": "sophia-doc",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "sophia-doc"
}
