docs

Documentation

This documentation is generated using JSDOC and Clean-Jsdoc-Theme.

Getting started

To generate the documentation :

git clone https://github.com/VCityTeam/UD-Viz.git
cd UD-Viz
npm install
npm run back-end # This command serve local doc at http://localhost:8000/docs/html/
npm run docs # Generate doc

The produced documentation should be in the docs/html repository.

The latest released version is hosted by Github Pages here : https://vcityteam.github.io/UD-Viz/html/index.html

Contribute

To document source code, refer to JSDOC syntax. You can run npm run dev-docs command to regenerate documentation each time you change packages' sources.

To document everything else (diagrams, tutorials, etc...), simply add them to the static directory. See jsdoc-tutorials for more information.