This project consists of two main parts of the automated generation of documentation for Siddhi Complex Event Processing Engine.

  1. a maven plugin for automated documentation generation for a single extension module or the siddhi core. The metadata annotated using the @Extension annotation are retrieved using the ClassIndex library which is already used by siddhi for indexing the annotated processor classes. Afterwards, documentation is generated using the metadata using a template engine.
  2. Creating an index of the Siddhi Extension Repositories.
  3. Adding and committing the docs/ directory content and the mkdocs.yml file to Git. Pushing the changes in the docs/ directory content and the mkdocs.yml file to origin master. Automatically deploying documentation in each new release of Siddhi.

Organization

Student

Nadun De Silva

Mentors

  • Suhothayan
  • Nirmal Fernando
close

2017