You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Raoul Snyman 8a3376b8bf Merge branch 'master' into 'master' 2 months ago
api Bump docs version to 3.0 2 years ago
common Moved things around a bit, put shared stuff into common. 11 years ago
manual Service doc updated 2 months ago
scripts Added docs for Xfce4 and workaround. 8 years ago
user-guide Added an introductory section on the front page with a link to the reference manual. 10 years ago
.gitignore Add the OpenLP documentation icon 4 years ago
.gitlab-ci.yml Use the documentation Docker image and build a PDF 4 years ago
LICENSE Add LICENSE file to release documentation under a CC-BY-SA-4.0 license. 4 years ago
PluginDevelopersGuide.txt Initial import of documentation. 12 years ago
README.rst Fix up the link at the bottom 4 years ago
openlp-docs-icon.png Add the OpenLP documentation icon 4 years ago
openlp-docs-icon.svg Add the OpenLP documentation icon 4 years ago
plugin.txt Initial import of documentation. 12 years ago
style_guide.rst Fixed #16 Add information about editing a Bible 4 years ago


OpenLP Documentation

This repository holds the OpenLP manual and some other documentation.

Getting Started

To get up and running with the documentation, you'll need to install Sphinx and the Read The Docs theme.


If you're using Linux, you'll want to check your package manager for those packages.


$ sudo apt install python3-sphinx python3-sphinx-rtd-theme


$ sudo dnf install python3-sphinx python3-sphinx_rtd_theme


On macOS you can install Sphinx via MacPorts or Homebrew.


$ sudo port install py37-sphinx py37-sphinx_rtd_theme


$ sudo brew install sphinx-doc

Homebrew doesn't have the Read The Docs theme, so you'll need to install it via pip:

$ sudo pip install sphinx_rtd_theme


On Windows you'll need to use pip to install Sphinx and the Read The Docs theme:

$ pip install sphinx sphinx_rtd_theme

Editing the Documentation

The documentation is written in reStructuredText. If you haven't ever used reStructuredText before, take a look at the reStructuredText primer for a good introduction to the format.

reStructuredText is a plain-text format, so any text editor will work. Popular editors are vim, Atom, Visual Studio Code (Linux, macOS, Windows), Notepad++ (Windows).

Building the Documentation

Now that you have the dependencies installed and you've edited some pages, you'll want to build the documentation. Let's start with the manual. Go into the manual directory, and then run make html:

$ cd manual
$ make html

This will run Sphinx on the documentation and build the HTML in the build/html directory. To view the documentation, let's run Python's built-in web server on that directory:

$ cd build/html
$ python3 -m http.server

Now open your browser to http://localhost:8000/ and you should see the OpenLP manual.