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

Generating developer documentation.

Browse Source
This commit is contained in:
Fioddor Superconcentrado 2021-03-05 13:12:54 +00:00
parent fef06f1d3c
commit 2618d77d93
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
HACKING.md
View File

@ -5,7 +5,7 @@ This document provides reference information for FreedomBox **contribution** hac
1. [Setting up and using development environments](#development-environments-setting-up-and-their-usage)
1. [Contributing translations + how to make/keep FreedomBox international](#makingkeeping-freedombox-international)
1. [Testing](#testing)
1. [Building user documentation](#building-the-user-documentation-separately)
1. [Documentation](#documentation)
1. [Submitting your changes](#submitting-your-changes)
1. [Other related stuff](#miscelanea)
@ -465,7 +465,9 @@ $ py.test-3 -n 4 --dist=loadfile --include-functional -m essential
[back to index](#hacking)
## Building the User Documentation Separately
## Documentation
### Building the User Documentation Separately
FreedomBox Service (Plinth) man page is built from DocBook source in the `doc/`
directory. FreedomBox manual is downloaded from the wiki is also available
@ -477,6 +479,10 @@ To build the documentation separately, run:
guest$ make -C doc
```
### Building Developer documentation
See [README.rst](doc/dev/README.rst) in `doc/dev` directory.
[back to index](#hacking)