Contributing Documentation

This guide assumes the reader has read the Contribution workflow for details about making changes to code within gstlal repo, since the documentation files are updated by a similar workflow.

Writing Documentation

In general, the gstlal documentation uses RestructuredText (rst) files ending in .rst or Markdown files ending in .md.

The documentation files for gstlal are located under gstlal/doc/source. If you add a new page (doc file), make sure to reference it from the main index page.

Useful Links:

• MyST Directive Syntax