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: Add instructions to setup developer documentation

Browse Source 
Signed-off-by: Joseph Nuthalapati <njoseph@riseup.net>
[sunil: Package is python3-sphinx-autobuild and not python3-sphinx-autodoc]
[sunil: Add about section, reindent]
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
This commit is contained in:
Joseph Nuthalapati 2019-11-09 22:27:46 +05:30 committed by Sunil Mohan Adapa
parent 307dc1585c
commit ad30321fac
No known key found for this signature in database
GPG Key ID: 43EA1CFF0AA7C5F2
1 changed files with 36 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
doc/dev/README.rst Normal file
View File

@ -0,0 +1,36 @@
.. 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
===================================
Setup on Debian
***************
Install the following Debian packages:
* python3-sphinx
* python3-sphinx-autobuild
If your preferred text editor doesn't have support for the reStructuredText
format, you can install a simple desktop application called ReText. It has live
preview support with split panes.
Viewing changes live in your browser
************************************
You do not need the virtual machine used for FreedomBox development running to
edit this documentation.
Run `make livehtml` from the current directory in the host machine. Visit
http://127.0.0.1:8000 to view the changes live in your browser as you edit the
.rst files in this directory. Your browser reloads the page automatically each
time you save an .rst file in the documentation.