Skip to content

Releases: epsilonkn/EasyDoc

1.4.0 - Directory treatment

Pre-release

Choose a tag to compare

Adds :

  • Generation of the documentation of a directory of python files, in two ways :

    • generating a doc file per python file
    • generating a single doc file for multiple python files
  • Interactive mode for generation : allows the user to customize the generation (see the README for further explainations)

  • Recursive search across sub-directories handled

  • Debug mode added for a better follow-up of the generation

V1.2.0 PyPI friendly

Choose a tag to compare

@epsilonkn epsilonkn released this 24 Feb 10:17

The module is officially on PyPI.

you can now download with :

pip install EasyDocPy

Adds :

  • custom comment lines
  • rewrite of the Parser class
  • "--version" command added

V1.1.1 : pip friendly

Choose a tag to compare

@epsilonkn epsilonkn released this 21 Feb 14:06

This version allows the user to add the module to the python path.
To do this, download the files, open a terminal in the main directory, and execute the command : py pip install -e .
when it is installed, check the readme to know how to use the module

V1.1 - Exe friendly

Choose a tag to compare

@epsilonkn epsilonkn released this 19 Feb 10:10

this version allow the user to compile the analyser.py file in order to create an exe of the module.
this exe can then be added to the PATH, following conditions for this manipulation to succeed.
after it has been added to the path, you'll be able to use the program anywhere.

Note : keep in mind it is still and "early" version of the project, some more updates and adds will be done to make it more modular and "use ready"

V1

V1

Choose a tag to compare

@epsilonkn epsilonkn released this 18 Feb 15:32

base of the module.
the module is able to analyse a python file, find classes, one line function declaration and multi line function declarations; it also finds the docstrings ofthe classes and functions/methods
it is able to build a basic markdown file documenting its findings