diff options
| author | Kieran Bingham <kieran.bingham@ideasonboard.com> | 2018-11-20 08:18:42 -0800 |
|---|---|---|
| committer | Kieran Bingham <kieran.bingham@ideasonboard.com> | 2018-11-28 11:10:11 +0000 |
| commit | c60069241f5ebd7c3a024435171efc58f3d01522 (patch) | |
| tree | fcab18f3daad55b71fddc5c7f61b24d28ec9672e /Documentation/contributing.rst | |
| parent | ce1c86c10cba48a1acc9b7ee745efb383077711a (diff) | |
Documentation: Introduce sphinx documentation
Utilise sphinx-build to generate documentation in HTML form, and
populate with some initial content.
An initial conf.py is generated from sphinx-quickstart and answering
initial questions.
Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>
Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
Diffstat (limited to 'Documentation/contributing.rst')
| -rw-r--r-- | Documentation/contributing.rst | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/Documentation/contributing.rst b/Documentation/contributing.rst new file mode 100644 index 00000000..dd6f5efa --- /dev/null +++ b/Documentation/contributing.rst @@ -0,0 +1,46 @@ +Contributing +============ + +libcamera is developed as a free software project and welcomes contributors. +Whether you would like to help with coding, documentation, testing, proposing +new features, or just discussing the project with the community, you can join +our official public communication channels, or simply check out the code. + +Mailing List +------------ + +We use a public mailing list as our main means of communication. You can find +subscription information and the messages archive on the `libcamera-devel`_ +list information page. + +.. _libcamera-devel: https://lists.libcamera.org/listinfo/libcamera-devel + +IRC Channel +----------- + +For informal and real time discussions, our IRC channel on Freenode is open to +the public. Point your IRC client to #libcamera to say hello, or use the `WebChat`_. + +.. _WebChat: https://webchat.freenode.net/?channels=%23libcamera&uio=d4 + +Source Code +----------- + +libcamera is in early stages of development, and no releases are available yet. +The source code is available from the project's git tree, hosted by LinuxTV. + + $ git clone git://linuxtv.org/libcamera.git + +Documentation +------------- + +Project documentation is created using `Sphinx`_. Source level documentation +is currently planned to utilise Doxygen integration. Please use this in your +development. + +Sphinx integration with Doxygen will be with either `Breathe`_ or `Exhale`_ +depending upon which system works best + +.. _Sphinx: http://www.sphinx-doc.org +.. _Breathe: https://breathe.readthedocs.io/en/latest/ +.. _Exhale: https://exhale.readthedocs.io/en/latest/ |