Skip to content
Snippets Groups Projects
Commit fb586f49 authored by James Kennington's avatar James Kennington
Browse files

add contributing doc pages

parent 3cd5bf39
No related branches found
No related tags found
1 merge request!70Add docs for contribution workflow and local development env
Pipeline #270154 passed
# Contributing Workflow
abc
# Contributing Documentation
This guide assumes the reader has read the [Contribution workflow](contributing.md) 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)](https://docutils.sourceforge.io/rst.html) files
ending in `.rst` or [Markdown](https://www.markdownguide.org/basic-syntax/) files ending in `.md`.
Useful Links:
- [MyST Directive Syntax](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#syntax-directives)
......@@ -45,6 +45,7 @@ The GstLAL software package is used for the following activities:
local_environment
contributing
contributing_docs
.. toctree::
:caption: API Reference
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment