Skip to main content
Warning: You are using the test version of PyPI. This is a pre-production deployment of Warehouse. Changes made here affect the production instance of TestPyPI (testpypi.python.org).
Help us improve Python packaging - Donate today!

Generate markdown from python docstrings.

Project Description

This is a Concept Only

Simpledoc is tool to create markdown (.md) files from your projects docstrings. The only requirments are to have a config file and and simpledoc installed. Then running the command will traverse your project modules and pull all the docstrings.

Test Installation

sudo pip install -i https://testpypi.python.org/pypi simpledoc

Typical Usage

[controllers.api]
document_name = README.md

[services]
include_classes = False
include_functions = False
document_name = README.md

Then run the simpledoc command.

$ simpledoc.py --config=my_config.ini

The output will be a README.md file with all the docstrings in the modules controllers.api and services.

Command Line Options

The following are the command line options:

  • –config=”file” : Required. File where the config settings are for this project.

Configuration Options

The following are settings that can be used for each section of a config file.

  • include_module: Include the docstring for the module.
  • include_classes: Include the docstring for each class.
  • include_class_methods: Include the docstring for each class method
  • include_functions: Include the docstring for each function in the module.
  • document_name: the path and file name of where the markdown file should be stored.
  • black_list: is a list of packages or modules to be ignored.
Release History

Release History

This version
History Node

0.1.4

History Node

0.1.3

History Node

0.1.2

History Node

0.1.1

History Node

0.1.0

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
simpledoc-0.1.4.tar.gz (3.3 kB) Copy SHA256 Checksum SHA256 Source Jul 28, 2015

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting