Keywords
shaon, document, generator, documentation
License
MIT
Install
pip install documentor==0.0.0.13.1

Documentation

Auto Documentation for developers

Author: Shaon Majumder

Utilities

  • Auto Documentation

Installation

pip install documentation

Function Usages

Function Usages End

Versioning

major.minor[.maintenance[.build]] (example: 1.4.3.5249)

adoption: major.minor.patch.maintenance.status.trials_for_success

The last position

  • 0 for alpha (status)
  • 1 for beta (status)
  • 2 for release candidate
  • 3 for (final) release

For instance:

  • 1.2.0.1 instead of 1.2-a1
  • 1.2.1.2 instead of 1.2-b2 (beta with some bug fixes)
  • 1.2.2.3 instead of 1.2-rc3 (release candidate)
  • 1.2.3.0 instead of 1.2-r (commercial distribution)
  • 1.2.3.5 instead of 1.2-r5 (commercial distribution with many bug fixes)