Skip to main content

Module reference by analyzing the syntax tree

Create reference documentation from sources using AST

pip install morast

Installation in a virtual environment is strongly recommended.

Usage

Output of python -m morast --help:

usage: morast [-h] [--version] [-d | -v | -q]
              {auto,extract,init,config,module} ...

Create reference documentation from sources using AST

positional arguments:
  {auto,extract,init,config,module}
    auto                automatically detect and document all modules
    extract             extract override templates from modules
    init                initialize the Morast project
    config              show the configuration
    module              document a single module

options:
  -h, --help            show this help message and exit
  --version             print version and exit

Logging options:
  control log level (default is WARNING)

  -d, --debug           output all messages (log level DEBUG)
  -v, --verbose         be more verbose (log level INFO)
  -q, --quiet           be more quiet (log level ERROR)

Further reading

Please see the documentation at https://blackstream-x.gitlab.io/morast for detailed usage information.

If you found a bug or have a feature suggestion, please open an issue here

Metadata

Release files for morast 0.3.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for morast 0.3.5
File Size Uploaded
morast-0.3.5.tar.gz 43.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for morast 0.3.5
File Interpreter ABI Platform
morast-0.3.5-py3-none-any.whl Python 3 none any Details

Total release size: 84.4 kB

Release files / morast-0.3.5.tar.gz

Download URL morast-0.3.5.tar.gz
Size 43.5 kB
Tags Source
SHA-256 checksum
How to use checksums
b2b91f9c412703dcb686447e45843ddfc16c17cace889158639ee22064f49bf9
BLAKE2b-256 checksum
How to use checksums
65aa0c13200420c214b3d6a3fd6338807ddd39e33acfa56eb980dd3bc4f4e6e7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.12.3

Release files / morast-0.3.5-py3-none-any.whl

Download URL morast-0.3.5-py3-none-any.whl
Size 40.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d6457d003cb38b66e870d51a8f91ef46368693a634d112812dc0030f92abe271
BLAKE2b-256 checksum
How to use checksums
fbb80ba55369eda205225606cc24a1fe14043907f7d658de3440b4d53b7cb78e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.12.3

Release history Release notifications | RSS feed

This release

0.3.5 This release

2 release files

0.3.4

2 release files

0.3.3

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.6

2 release files

0.2.5

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page