Skip to main content

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


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.9.tar.gz (12.4 kB view details)

Uploaded Source

Built Distribution

sophia_doc-0.1.9-py3-none-any.whl (13.4 kB view details)

Uploaded Python 3

File details

Details for the file sophia_doc-0.1.9.tar.gz.

File metadata

  • Download URL: sophia_doc-0.1.9.tar.gz
  • Upload date:
  • Size: 12.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.14

File hashes

Hashes for sophia_doc-0.1.9.tar.gz
Algorithm Hash digest
SHA256 3d7df0de9b112419d6491f8cb6bdf0c9d73a7a26e189ca677c01af26d3f6371e
MD5 8852ac1529634133d250b52c217343cb
BLAKE2b-256 29398c10ffc05fb9a2e812eba6fed38643db01c8f7fbf118ca3f6e12a816ff96

See more details on using hashes here.

File details

Details for the file sophia_doc-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: sophia_doc-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 13.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.14

File hashes

Hashes for sophia_doc-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 a93af64d3c529d40c32cb756fec84eb0e5bbabe5ff33ffe2659f405751fe8ced
MD5 b39972620e79c779c266f0d233d68a38
BLAKE2b-256 6da8c54eb7423197ae9738520aa8009b73966c2b0beec6eca0c046efe605ec83

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page