A python package to automatically generate API documents for Python modules.
Project description
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
pip install sophia-doc
Quickstart
sophia_doc "sophia_doc" -o ./doc
Usage
Command line:
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
sophia_doc-0.1.8.tar.gz
(14.0 kB
view details)
Built Distribution
File details
Details for the file sophia_doc-0.1.8.tar.gz
.
File metadata
- Download URL: sophia_doc-0.1.8.tar.gz
- Upload date:
- Size: 14.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: pdm/2.12.4 CPython/3.12.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f3b3c7f2950044c5fe1a1ad484e103f49120458528106551ea75410b316d8887 |
|
MD5 | c3ec2e1f4307afa77e1944c02ed1b3fa |
|
BLAKE2b-256 | 43310e9647a17c4123a8ee016566dc4acc1858773431ebe71608adde81dd0ffc |
File details
Details for the file sophia_doc-0.1.8-py3-none-any.whl
.
File metadata
- Download URL: sophia_doc-0.1.8-py3-none-any.whl
- Upload date:
- Size: 14.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: pdm/2.12.4 CPython/3.12.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 16a82f6dc5a7110f9a8aa03adfb012b2d67c2d2a392fda0fe5c23247de9afcd2 |
|
MD5 | 4c265185c83f7b28b3cf1b9fa0ceb7c3 |
|
BLAKE2b-256 | 61646a86510ebf477d35d07865a74f50ff0e786551aed4dac1e0bfa9f0a6606c |