mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-28 08:03:36 +00:00
ac3754fa2f
- This improves modularity. Each app brings its own icons in its directory instead of a centralized directory. Tests: - Install an app and notice that the installation notification has the icon. - Visit an app's page in Apps and System (cockpit) section and ensure that the app's icon is being shown. - Visit the Apps and System section and notice that apps' icons are being shown. - Visit the home page and notice that shortcuts' icons are being shown. - Visit the URL /plinth/api/0/shortcuts and notice that the URLs for icons are accessible and lead to proper icon files. - Build developer documentation and notice that Tutorial -> View and Reference > Menu pages show the expected updates. 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.