begriffs open source - cmsis/blob - CMSIS/Documentation/README.md

   1 # CMSIS 6 Documentation
   2
   3 CMSIS 6 Documentation in HTML format is published online at [https://arm-software.github.io/CMSIS_6](https://arm-software.github.io/CMSIS_6).
   4
   5 The version drop-down menu in the "Overview" book allows to switch between the documentation provided with official releases and the latest draft documentation for the main branch.
   6
   7 The documentation source is maintained in `/CMSIS/Documentation/Doxygen/` folder as a mixture of markdown and doxygen formats. Software source and header files, templates and examples may also contribute information that gets integrated into the final documentation.
   8
   9 Generating the HTML-formatted documentation from the source is done with `gen_doc.sh` script:
  10
  11 ```sh
  12 CMSIS_6 $ ./CMSIS/Documentation/Doxygen/gen_doc.sh
  13 ```
  14
  15 The script expects specific version of [doxygen](https://www.doxygen.nl/) to be installed locally. After successful execution the resulting documentation package is then available in `./CMSIS/Documentation/html/`.