Eighth Week

In eighth week, we achieved following goals:


  1. Generate Links to any external Documentation for given ecl source tree.
  2. 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.
  3. To generate external documentation, each ecldoc run generates a tree.json file for each folder in given ecl source tree.
  4. 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.
  5. 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.
  6. {
    "input_root": "/media/sarthak/Data/ecldoc/testing/test",
    "output_root": "/media/sarthak/Data/ecldoc/testing/test-docs",
    "tree": {
        "example": {
            "key": "example.ecl",
            "tree": "example.ecl"
        },
        "example_8": {
            "key": "example_8.ecl",
            "tree": "example_8.ecl"
        },
        "intest": {
            "key": "intest",
            "tree": {
                "example_11": {
                    "key": "example_11.ecl",
                    "tree": "intest/example_11.ecl"
                },
                "inintest": {
                    "key": "inintest",
                    "tree": {
                        "example_2": {
                            "key": "example_2.ecl",
                            "tree": "intest/inintest/example_2.ecl"
                        },
                    }
                }
            }
        },
    }
}

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