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

Sixth Week

In sixth week, we achieved following goals : PDF Documentation was generated. To generate PDF Doc, we generate LATEX files for each source and then run pdflatex on them. XML Doc was read to get appropriate information for PDF Doc. Jinja2 library was used to generate template for latex files. New jinja2 environment was created as default environment clashes with latex syntax. New jinja2 filter was added to escape special chars present in latex. The Definition can not be indented in pdf, so used breadcrumbs bar in each definition to show its ancestors in definition tree. Each folder was also given a pkg.toc.tex file to create a table of contents. It contained bundle info, if any and links to individual source file along with first line of the that source. PDF Documentation was generated from tex files by combining them using \input in latex. Using this, we create an overall documentation (for complete source tree) and individual folder documentation (for all files in one fol
Read more

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

Tenth Week

In tenth week, we achieved following : Ecldoc installation was determined. We used setup.py from setuptools to generate installation information for the project as python package. Requirements for projects was determined as jinja2 and lxml. All data files in Templates folder was added to setup.py as data files. A single script was added to bin directory to act as entry point for the ecldoc utility. We use pip to perform actual installation (for easy uninstall). We generated a Makefile with 2 targets - install and uninstall. Each target can be run with root permissions to install for all users and local permissions to install for given user only. Documentation was updated with installation info.
Read more