Skip to main content

Automatic style guide and docstrings generator for Python code

Project description

alphadoc

Automatic docstring generator and style guide that supports a number of specified conventions for documentation in Python.

Installation

Using pip:

$ pip install alphadoc

Using local build:

$ git clone https://github.com/MLH-Fellowship/alphadoc.git
$ pip install -e .
$ python setup.py install
$ python setup.py sdist bdist_wheel

Usage

alphadoc takes your filename and format type as arguments

$ alphadoc <filename> --d <doc_format>

See alphadoc --help for more command-line switches and options!

Features

  • Auto-generates docstrings with a customizable template for functions and classes.
  • Automatically fixes the code according to the standard PEP-8 style convention for python.
  • Support for common and widely used docstrings formats such as Numpy, Google, ReStructured Text and Epytext (Javadoc)

Contributing

alphadoc is fully Open-Source and open for contributions! We request you to respect our contribution guidelines as defined in our CODE_OF_CONDUCT.md and CONTRIBUTING.md

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

alphadoc-1.0.1.tar.gz (2.0 kB view hashes)

Uploaded Source

Built Distributions

alphadoc-1.0.1-py3.6.egg (2.0 kB view hashes)

Uploaded Source

alphadoc-1.0.1-py3-none-any.whl (2.9 kB view hashes)

Uploaded Python 3

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