#Digikam and pdf install#

:target: getting_started.html Preview link on the documentation figure:: images/index_getting_started.webp Visual preview of the section Getting started Section title declared on the front page Screen-shots, taken in WEBP format, and a nested videos sub-directory to host screen-casts in animated WEBP format.įor example, the getting_started section will be organized like this: rst files, a nested images sub-directory to host Sub-directory with the same name including chapters. rst file from top level directory and a dedicated The root entry of the manual is index.rst.Įach handbook section start with a. rst files and sub-directories with the same nameĬorresponding to the handbook sections. ReStructuredText documentation implementation is located in top level directory in.

tests : scripts to test repository contents with Continuous integration.Īll others directories are used to host sections of the documentation implemented in ReStructuredText format.

ressources: Sphinx templates customization.

project : some helpers scripts and LibreOffice schemes.

locale : link to updated handbook translations files.

build : temporary dir created when documentation is compiled.

LICENSES : all licenses used in the project.

Open the file DigikamManual.epub in your preferred e-book reader. The EPUB ebook is generated in build/epub. Open the file index.html in your preferred web browser.

with cd /path/to/digikam-docs) Generate an HTML Web Documentation You can check whether Sphinx was installed successfully by running sphinx-build -versionĪfter you cloned this repository (only need to be done once), use a command line to go to its root folder (e.g.

#Digikam and pdf install#

To install Sphinx and the Sphinx Theme use sudo apt install python3-sphinx python3-sphinx-rtd-theme.

This documentation generated as EPUB can be downloaded here. This documentation generated as HTML can be read online here. This repository hosts the digiKam handbook based on Sphinx framework and ReStructuredText format.ĭigiKam is a powerful Open Source Photo Management Software.