nik/FreedomBox
1
0
Fork 0
mirror of https://github.com/freedombox/FreedomBox.git synced 2026-01-21 07:55:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc/dev: Include information on how to edit dev documentation

Browse Source 
This also avoid the warning "README.rst: WARNING: document isn't included in any
toctree".

Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
This commit is contained in:
Sunil Mohan Adapa 2020-02-11 16:28:27 -08:00 committed by James Valleroy
parent e36781af77
commit 1dd40f5c7a
No known key found for this signature in database
GPG Key ID: 77C0C75E7B650808
2 changed files with 16 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/dev/README.rst
View File

@ -1,17 +1,17 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
About
=====
This directory contains the FreedomBox Developer Manual. Specifically the
tutorial for writing new applications and API reference for writing apps for
FreedomBox. It is kept as part of the main FreedomBox source code with the
expectation that when the API changes the developer documentation is also
updated in the same patch set.
Editing the Developer Documentation
===================================
About
*****
The doc/dev directory in FreedomBox repository contains the FreedomBox Developer
Manual. Specifically the tutorial for writing new applications and API reference
for writing apps for FreedomBox. It is kept as part of the main FreedomBox
source code with the expectation that when the API changes the developer
documentation is also updated in the same patch set.
Setup on Debian
***************

7
doc/dev/index.rst
View File

@ -30,6 +30,13 @@ External References
#. `FreedomBox User Manual <https://wiki.debian.org/FreedomBox/Manual>`_
Contributing to this Documentation
**********************************
.. toctree::
README
Indices and tables
******************