Skip to main content

Module reference by analyzing the syntax tree

Project description

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

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

morast-0.3.5.tar.gz (43.5 kB view details)

Uploaded Source

Built Distribution

morast-0.3.5-py3-none-any.whl (40.8 kB view details)

Uploaded Python 3

File details

Details for the file morast-0.3.5.tar.gz.

File metadata

  • Download URL: morast-0.3.5.tar.gz
  • Upload date:
  • Size: 43.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for morast-0.3.5.tar.gz
Algorithm Hash digest
SHA256 b2b91f9c412703dcb686447e45843ddfc16c17cace889158639ee22064f49bf9
MD5 08809d930eacd6b0b6a958fac3eb72b0
BLAKE2b-256 65aa0c13200420c214b3d6a3fd6338807ddd39e33acfa56eb980dd3bc4f4e6e7

See more details on using hashes here.

Provenance

File details

Details for the file morast-0.3.5-py3-none-any.whl.

File metadata

  • Download URL: morast-0.3.5-py3-none-any.whl
  • Upload date:
  • Size: 40.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for morast-0.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 d6457d003cb38b66e870d51a8f91ef46368693a634d112812dc0030f92abe271
MD5 5f696fc7d551757d5424c68956c28310
BLAKE2b-256 fbb80ba55369eda205225606cc24a1fe14043907f7d658de3440b4d53b7cb78e

See more details on using hashes here.

Provenance

Supported by

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