7 Commits

Author SHA1 Message Date
Joseph Nuthalapati
4b0899fd65
docs: Improve Developer Documentation index page
- Improved readability.
- Changed hierarchy of headings.
- Reduced emphasis on unnecessary/redundant things.
- Added links to go back to the main websites.

Signed-off-by: Joseph Nuthalapati <njoseph@riseup.net>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
2021-03-07 07:14:30 -05:00
Sunil Mohan Adapa
b378305f58
doc: dev: Update the tutorial to reflect latest API/code
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: Veiko Aasa <veiko17@disroot.org>
2021-01-04 13:47:41 +02:00
Sunil Mohan Adapa
1dd40f5c7a
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 <jvalleroy@mailbox.org>
2020-02-16 18:22:14 -05:00
Joseph Nuthalapati
8225de973c
doc: dev: Fix headings
Signed-off-by: Joseph Nuthalapati <njoseph@riseup.net>
Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
2019-11-09 17:11:18 -08:00
Joseph Nuthalapati
bc1ab90630
doc: dev: Reduce toc depth to 2 levels to reduce noise
Signed-off-by: Joseph Nuthalapati <njoseph@riseup.net>
Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
2019-11-09 17:11:11 -08:00
Joseph Nuthalapati
f424c80a0a
doc: dev: Mention where to find the user manual
Signed-off-by: Joseph Nuthalapati <njoseph@riseup.net>
[sunil: Minor wording changes]
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
2019-11-09 17:11:04 -08:00
Sunil Mohan Adapa
80498919fb
doc: Add developer documentation using Sphinx
- This is completely reworked but based on /Developer page in the FreedomBox
  Manual.

- This documentation can be made available as static site on
  https://docs.freedombox.org and the /Developer page in the FreedomBox Manual
  can be dropped.

Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
2019-11-02 13:51:14 -04:00