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 doc from your Python docstrings

Project Description

pymarkdoc

Generate Markdown doc from your Python docstrings

License

Software licensed under MPL 2.0 license.

Installation

pip install pymarkdoc

Development

To run all the tests: tox

I need help to make this tool available on command line. The thing is that getdoc needs a module as an object to get its documentation, so we have to import it. To import it, all the modules it is importing have to be installed (either on the system or in the current virtual environment). Python path also must have been set correctly. Even more, in the case of a Django project, settings have to be set up. This require many options and checks to be developed!

Todo:

  • Make tool available on command line
  • Add a command-line option to specify a virtualenv to activate
  • Add command-line options to work with frameworks (Django, Flask, …)
  • Add command-line options to configure the rendering method

Changelog

0.1.0 (2016-11-17)

  • Alpha release on PyPI.
Release History

Release History

This version
History Node

0.2.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
pymarkdoc-0.2.0-py2.py3-none-any.whl (4.7 kB) Copy SHA256 Checksum SHA256 py2.py3 Wheel Nov 18, 2016
pymarkdoc-0.2.0.tar.gz (15.2 kB) Copy SHA256 Checksum SHA256 Source Nov 18, 2016

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