Fineract-CN API documentation

The aim of this project is to bring together all the generated Fineract-CN API documentation. This project contains both generated documentation as well as instructions how to re-generate.

Browse generated documentation

Start here

Re-generate the documentation

1. Clone this project next to other fineract-cn- projects. You need to have following directory structure:

your_workspace_dir/
                   fineract-cn-api-docs
                   fineract-cn-identity
                   fineract-cn-customer
                   fineract-cn-accounting
                   ...
 

1. You need to have Cassandra and MySQL/MariaDB running

2. You need to run the classes in this table:

   https://cwiki.apache.org/confluence/display/FINERACT/Apache+Fineract+CN+API+Documentation

3. For this right click in your IDE and click RUN (some don't work this way - need yet to solve)

4. Under build/doc/generated-snippets/{module name} check that there are folders generated

5. In current project run ./generate_doc.sh