Writing Documentation

There are three kinds of documentation in CSLE:

• Release documentation (the document you are reading now). This document is generated for each major release only. It is a PDF generated through LaTeX.
• Live web documentation. This documentation is generated with Ruby. The source files are located at csle/docs. This documentation is updated automatically on every code commit to the project. To generate the web documentation manually, run the command:

   bundle exec Jekyll serve
  

  Listing 133: Command to generate the web documentation at https://kim-hammar.github.io/csle//.

• Python API documentation. This documentation is generated automatically from code comments using sphinx. To generate the API documentation, run the command:

   simulation-system/libs/generate_docs.sh
  

  Listing 134: Command to generate the Python API documentation.