Metadata-Version: 2.1
Name: morast
Version: 0.3.3
Summary: MOdule Reference by Analyzing the Syntax Tree
Author-email: Rainer Schwarzbach <rainer@blackstream.de>
License: MIT License
        
        Copyright (c) 2023 Rainer Schwarzbach
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://gitlab.com/blackstream-x/morast
Project-URL: Documentation, https://blackstream-x.gitlab.io/morast
Project-URL: CI, https://gitlab.com/blackstream-x/morast/-/pipelines
Project-URL: Bug Tracker, https://gitlab.com/blackstream-x/morast/-/issues
Project-URL: Repository, https://gitlab.com/blackstream-x/morast.git
Keywords: ast,documentation
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Pre-processors
Classifier: Topic :: Text Processing :: Markup :: Markdown
Classifier: Intended Audience :: Developers
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: PyYAML>=6.0.1
Requires-Dist: smdg>=0.2.0

# 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 `python3 -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](https://gitlab.com/blackstream-x/morast/-/issues)

