Second Week

In second week, we achieved following functionality :

  1. Basic structure of ecldoc utility was generated in python.
  2. Python utility uses a configuration file as input that specifies :
    1. Input root of documentation - where we start processing the files
    2. Glob patterns wrt to input root for files to be processed.
    3. Output root - where output documentation will be stored.
    4. format of documentation required.
  3. Glob pattern were parsed using glob utility in python 3.
  4. LXML lib was used for processing XML in python 3.
  5. XML documentation was generated for each files matched by glob pattern.
  6. To gen XML documentation, first we run ecldoc using subprocess in python to obtain original xml output from ecldoc -M
  7. Then we use LXML to parse this XMLOriginal to generate new XML.
  8. New XML contains :
    1. Signature of each attribute by reading corresponding source code .
    2. Documentation parser was rewritten in python.

Comments

Post a Comment

Popular posts from this blog

Fifth Week

In fifth week, we achieved following goals : Text Documentation was generated. XML Doc was read to get appropriate information for Text Documentation. Jinja2 library was used to generate Template. For Text Documentation, we limited all information display to 150 chars per line. The Definition was indented on basis of their level in the tree. We use textwrap library to heuristically break long sentences along word boundaries. Each folder was also given a pkg.toc.txt file, which contained bundle information and links to all files in that folder. Heuristic signature breaking was designed. The signature for definition was read and broken into return type, name and parameter string. The breaking occured along heuristic : break at first incidence of name in the sign that it not enclosed by brackets and ends in whitespace or '('. Then break at end of the name.
Read more

Eighth Week

In eighth week, we achieved following goals: Generate Links to any external Documentation for given ecl source tree. For example , if project A has IMPORT B.B1; stmt in some file and we have included path to B Code in eclcc using -I option, that we can also include path to documentation of B which will be linked correctly to any such import stmts in documentation of A. To generate external documentation, each ecldoc run generates a tree.json file for each folder in given ecl source tree. Tree.json files provides paths to each file starting from the folder the json file is in. If the corresponding source path is included in eclcc, we can determine target path using this json file. Example - If input_root below is included in -I option of eclcc, then any imports of keys in tree (example_8, intest, intest.example_11, intest.inintest, intest.inintest.example_2) will be linked correctly to documentation in output_root in each format. { "input_root": "/media/sart
Read more

Ninth Week

In ninth week, we achieved following goals : Generates Documentation for Users in clienttools documentation format. Code Refactoring : Here we reworked the code, so that all output formats are present in separate directories. This will allow easier extension to other formats in future. The only file needed to be modified to add more formats is Formats/generators.py and it will be added to ecldoc. Templates were moved to separate directory which makes it easier to install using setuptools in python. Code was reworked to generate absolute imports rather than relative imports. This makes it easier to move the destination of imports. Code was documented using docstrings and comments wherever required. Technical Documentation was generated to inform overall working of ecldoc code for future.
Read more