Remove instructions to use the PPA See merge request openlp/documentation!30
This repository holds the OpenLP manual and some other documentation.
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
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
$ 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.