mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-21 07:55:00 +00:00
75f6abac1e
- Primary purpose is to complete the App API and allow for multiple apps to be present in a module without a single clashing setup() method. Secondary objective is to get rid of SetupHelper instance simple use App instance instead. - This brings us closer to not needing to implement setup() method for some of the typical apps. - Remove default value None for old_version parameter. - A valid integer value is always passed to this call. - The value of None is undefined. - Simplifies the App API slightly. - Drop setting 'pre', 'post' values to indicate the stage of setup for the App. - Simplifies the setup methods significantly. Eliminates a class of bugs (some of them seen earlier). - The UI can show a simple 'installing...' or progress spinner instead of individual stages. - There are currently many inconsistencies where many operations are not wrapped in helper.call() calls. Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org> Reviewed-by: James Valleroy <jvalleroy@mailbox.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 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.