Skip to main content

StandAlone Async single-file cross-platform no-dependenciesUnicode Python3 Multi-Format Auto Documentation Generator.Imagine that we mix together Sphinx, PanDoc, Material Design, MkDocs, eBooks,LibreOffice Docs, K.I.S.S. principle and take out all the bloat,then Dookumentation born, enjoy 'The Dark Side of Documentation' !.

Project description

The Dark Side of Documentation

Usage:

dookumentation.py file.py

dookumentation.py /path/to/folder/

Plugins Usage:

  • Download and save the plugins to /doc/plugins/, thats all.

Install

PIP: (Recommended!)

sudo pip3 install dookumentation

Requisites:

Output Formats

  • HTML5, Material Design, Minified *.html
  • MarkDown, GitHub Compatible, Pretty-Printed *.md
  • RST, ReSTructuredText, Pretty-Printed *.rst
  • JSON, Pretty-Printed, JavaScript Compatible *.json
  • ODT, ODF ODT Document, LibreOffice Compatible *.odt
  • eBook, Compressed eBook with HTML5 Documentation, ePub3 compliant, optional via --ebook parameter *.epub
  • ZIP, Compressed ZIP with HTML5 Documentation inside, optional via --zip parameter *.zip
  • SVG for the Web, HTML5 <svg> standalone document, Pretty-Printed *.svg
  • XML, generic XML, Pretty-Printed *.xml
  • TXT, Unformatted Plain Text *.txt
  • More

Input Formats

  • *.py, *.pyw Python source code file, single file or whole folders recursively.

StandAlone Async single-file cross-platform no-dependencies Unicode Python3 Multi-Format Auto Documentation Generator. Imagine that we mix together Sphinx, PanDoc, Material Design, MkDocs, eBooks, LibreOffice Docs, K.I.S.S. principle and take out all the bloat, then Dookumentation born, enjoy ‘The Dark Side of Documentation’ !.

Project details


Download files

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

Files for dookumentation, version 1.2.0
Filename, size File type Python version Upload date Hashes
Filename, size dookumentation-1.2.0-py3.5.egg (74.5 kB) File type Egg Python version 3.5 Upload date Hashes View
Filename, size dookumentation-1.2.0.tar.bz2 (54.9 kB) File type Source Python version None Upload date Hashes View
Filename, size dookumentation-1.2.0.tar.gz (70.2 kB) File type Source Python version None Upload date Hashes View
Filename, size dookumentation-1.2.0.zip (79.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page