mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-03-11 09:04:54 +00:00
365c1c3484
- Change theme to 'Book' based on Sphinx pydata theme. It supports dark/light modes. Looks more modern and better defaults/options. - Add logo on the top left corner. - Add menu to go to repository, view page source, edit page source, and report issue on current page. - Don't repeat 'FreedomBox Authors' in authors text and copyright text. Show only once as suggested by the theme. - Use theme option to show license link instead of overriding the template. Tests: - After building the theme, all options work as expected. - Footer appears as expected. Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
.. SPDX-License-Identifier: CC-BY-SA-4.0 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 *************** Install the following Debian packages: * python3-sphinx * python3-sphinx-autobuild * python3-sphinx-book-theme * python3-django * python3-django-axes * python3-django-captcha * python3-django-ipware * python3-django-stronghold 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.