# How to write documentation #

- Example for texinfo documentation:
  https://github.com/gnu-octave/octave/blob/default/scripts/geometry/inpolygon.m
- Extract documentation from file:  
  `[txt, form] = get_help_text_from_file(make_absolute_filename('pkg/inst/some_function.m'))`
- Generate HTML documentation from single file:  
  ```octave
pkg uninstall caosdb
pkg install caosdb.tar.gz
pkg load caosdb
html_help_text('some_function', './htdocs/some.html', 'octave-forge', pkgname="caosdb")
```
- Generate HTML documentation for a package:  
  ```octave
generate_package_html('caosdb', 'htdocs', 'octave-forge')
```