From 1dd40f5c7a0a07c29a0b33829219d616169e9c97 Mon Sep 17 00:00:00 2001 From: Sunil Mohan Adapa Date: Tue, 11 Feb 2020 16:28:27 -0800 Subject: [PATCH] doc/dev: Include information on how to edit dev documentation This also avoid the warning "README.rst: WARNING: document isn't included in any toctree". Reviewed-by: James Valleroy --- doc/dev/README.rst | 18 +++++++++--------- doc/dev/index.rst | 7 +++++++ 2 files changed, 16 insertions(+), 9 deletions(-) diff --git a/doc/dev/README.rst b/doc/dev/README.rst index bef75e3f0..9df33066e 100644 --- a/doc/dev/README.rst +++ b/doc/dev/README.rst @@ -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 *************** diff --git a/doc/dev/index.rst b/doc/dev/index.rst index 1f3e1ee6d..f9e5966c3 100644 --- a/doc/dev/index.rst +++ b/doc/dev/index.rst @@ -30,6 +30,13 @@ External References #. `FreedomBox User Manual `_ +Contributing to this Documentation +********************************** + +.. toctree:: + + README + Indices and tables ******************