Added rst2pdf support and moved sections out to their own files.

This commit is contained in:
Raoul Snyman 2012-07-06 22:47:24 +02:00
parent f17453fc36
commit df30a8638b
6 changed files with 204 additions and 90 deletions

View File

@ -151,3 +151,8 @@ doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \ @echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt." "results in $(BUILDDIR)/doctest/output.txt."
pdf:
$(SPHINXBUILD) -b pdf $(ALLSPHINXOPTS) build/pdf
@echo
@echo "Build finished. The PDF files are in build/pdf."

View File

@ -0,0 +1,18 @@
.. _adding-content:
Adding More Content
===================
Now that you've got a mostly workable OpenLP installation, how do you get all your songs and things into OpenLP?
Importing Songs
---------------
You've been using EasyWorship, this is how you get your songs out of it.
Importing a Bible
-----------------
You need to be able to project Bible verses, this shows you how to get Bibles into OpenLP.
Loading a Presentation
----------------------
Adding Videos and Images
------------------------

View File

@ -25,7 +25,7 @@ import sys, os
# Add any Sphinx extension module names here, as strings. They can be extensions # Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [] extensions = ['sphinx.ext.autodoc','rst2pdf.pdfbuilder']
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']
@ -48,9 +48,9 @@ copyright = u'2012, OpenLP Team'
# built documents. # built documents.
# #
# The short X.Y version. # The short X.Y version.
version = '0.1' version = '2.0'
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = '0.1' release = '2.0'
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
@ -70,7 +70,7 @@ exclude_patterns = []
#default_role = None #default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text. # If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True add_function_parentheses = True
# If true, the current module name will be prepended to all description # If true, the current module name will be prepended to all description
# unit titles (such as .. function::). # unit titles (such as .. function::).
@ -103,7 +103,7 @@ html_theme = 'default'
# The name for this set of Sphinx documents. If None, it defaults to # The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation". # "<project> v<release> documentation".
#html_title = None html_title = 'OpenLP 2.0 User Guide'
# A shorter title for the navigation bar. Default is the same as html_title. # A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None #html_short_title = None
@ -164,7 +164,7 @@ html_static_path = ['_static']
#html_file_suffix = None #html_file_suffix = None
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'OpenLPUserGuidedoc' htmlhelp_basename = 'openlp-user-guide'
# -- Options for LaTeX output -------------------------------------------------- # -- Options for LaTeX output --------------------------------------------------
@ -183,7 +183,7 @@ latex_elements = {
# Grouping the document tree into LaTeX files. List of tuples # Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]). # (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [ latex_documents = [
('index', 'OpenLPUserGuide.tex', u'OpenLP User Guide Documentation', ('index', 'OpenLP-User-Guide.tex', u'OpenLP User Guide',
u'OpenLP Team', 'manual'), u'OpenLP Team', 'manual'),
] ]
@ -213,7 +213,7 @@ latex_documents = [
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
('index', 'openlpuserguide', u'OpenLP User Guide Documentation', ('index', 'openlp-user-guide', u'OpenLP User Guide',
[u'OpenLP Team'], 1) [u'OpenLP Team'], 1)
] ]
@ -227,8 +227,8 @@ man_pages = [
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
('index', 'OpenLPUserGuide', u'OpenLP User Guide Documentation', ('index', 'OpenLP-User-Guide', u'OpenLP User Guide',
u'OpenLP Team', 'OpenLPUserGuide', 'One line description of project.', u'OpenLP Team', 'OpenLP-User-Guide', 'One line description of project.',
'Miscellaneous'), 'Miscellaneous'),
] ]
@ -240,3 +240,100 @@ texinfo_documents = [
# How to display URL addresses: 'footnote', 'no', or 'inline'. # How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote' #texinfo_show_urls = 'footnote'
# -- Options for PDF output --------------------------------------------------
# Grouping the document tree into PDF files. List of tuples
# (source start file, target name, title, author, options).
#
# If there is more than one author, separate them with \\.
# For example: r'Guido van Rossum\\Fred L. Drake, Jr., editor'
#
# The options element is a dictionary that lets you override
# this config per-document.
# For example,
# ('index', u'MyProject', u'My Project', u'Author Name',
# dict(pdf_compressed = True))
# would mean that specific document would be compressed
# regardless of the global pdf_compressed setting.
pdf_documents = [
('index', u'OpenLP', u'OpenLP User Guide', u'OpenLP Team'),
]
# A comma-separated list of custom stylesheets. Example:
pdf_stylesheets = ['sphinx','kerning','a4']
# A list of folders to search for stylesheets. Example:
pdf_style_path = ['.', '_styles']
# Create a compressed PDF
# Use True/False or 1/0
# Example: compressed=True
pdf_compressed = True
# A colon-separated list of folders to search for fonts. Example:
# pdf_font_path = ['/usr/share/fonts', '/usr/share/texmf-dist/fonts/']
# Language to be used for hyphenation support
#pdf_language = "en_US"
# Mode for literal blocks wider than the frame. Can be
# overflow, shrink or truncate
#pdf_fit_mode = "shrink"
# Section level that forces a break page.
# For example: 1 means top-level sections start in a new page
# 0 means disabled
#pdf_break_level = 0
# When a section starts in a new page, force it to be 'even', 'odd',
# or just use 'any'
#pdf_breakside = 'any'
# Insert footnotes where they are defined instead of
# at the end.
#pdf_inline_footnotes = True
# verbosity level. 0 1 or 2
#pdf_verbosity = 0
# If false, no index is generated.
#pdf_use_index = True
# If false, no modindex is generated.
#pdf_use_modindex = True
# If false, no coverpage is generated.
#pdf_use_coverpage = True
# Name of the cover page template to use
#pdf_cover_template = 'sphinxcover.tmpl'
# Documents to append as an appendix to all manuals.
#pdf_appendices = []
# Enable experimental feature to split table cells. Use it
# if you get "DelayedTable too big" errors
#pdf_splittables = False
# Set the default DPI for images
#pdf_default_dpi = 72
# Enable rst2pdf extension modules (default is only vectorpdf)
# you need vectorpdf if you want to use sphinx's graphviz support
#pdf_extensions = ['vectorpdf']
# Page template name for "regular" pages
#pdf_page_template = 'cutePage'
# Show Table Of Contents at the beginning?
#pdf_use_toc = True
# How many levels deep should the table of contents be?
pdf_toc_depth = 9999
# Add section number to section references
pdf_use_numbered_links = False
# Background images fitting mode
pdf_fit_background_mode = 'scale'

View File

@ -0,0 +1,18 @@
.. _getting-more:
Getting More Out of OpenLP
==========================
Using the Web Remote
--------------------
Slide Shows
-----------
Backing Tracks
--------------
Finding Out More
----------------
View our `reference manual <http://manual.openlp.org/>`_.

View File

@ -0,0 +1,50 @@
.. _getting-started:
Getting Started
===============
In this section we'll be taking you through the first steps to getting OpenLP up and running on your computer.
Downloading & Installing
------------------------
So, you've come to the side, and you want to get this awesome software. How do you do it?
Windows
*******
Download the Windows Installer. Run it.
Mac OS X
********
Download the Mac OS X disk image. Mount it. Copy OpenLP into your Applications folder.
Ubuntu
******
Open your package manager. Search for OpenLP. Click Install.
Fedora
******
Open your package manager. Enable extras. Search for OpenLP. Click Install.
Running for the First Time
--------------------------
When OpenLP starts up for the first time, it may take a little while to get started due to the fact that it needs to perform some initial setup.
First Time Wizard
*****************
When you run OpenLP for the first time, it will run the First Time Wizard to help you get a few things into OpenLP to make it more usable.
Adding Songs
************
Once you've got OpenLP configured, you can start adding songs.
Creating a Service
******************
Now that you have a few songs, you can create a proper service.
Running a Service
*****************
If you have a service, you need to know how to run it.
Changing How Things Look
************************
To change how songs look, we need to add or edit **themes**.

View File

@ -3,90 +3,16 @@
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
Welcome to OpenLP User Guide's documentation! Welcome to the OpenLP 2.0 User Guide
============================================= ====================================
Contents: Contents:
.. toctree:: .. toctree::
:maxdepth: 2 getting-started
adding-content
getting-more
Getting Started :maxdepth: 2
===============
In this section we'll be taking you through the first steps to getting OpenLP up and running on your computer.
Downloading & Installing
------------------------
So, you've come to the side, and you want to get this awesome software. How do you do it?
Windows
*******
Download the Windows Installer. Run it.
Mac OS X
********
Download the Mac OS X disk image. Mount it. Copy OpenLP into your Applications folder.
Ubuntu
******
Open your package manager. Search for OpenLP. Click Install.
Fedora
******
Open your package manager. Enable extras. Search for OpenLP. Click Install.
Running for the First Time
--------------------------
When OpenLP starts up for the first time, it may take a little while to get started due to the fact that it needs to perform some initial setup.
First Time Wizard
*****************
When you run OpenLP for the first time, it will run the First Time Wizard to help you get a few things into OpenLP to make it more usable.
Adding Songs
************
Once you've got OpenLP configured, you can start adding songs.
Creating a Service
******************
Now that you have a few songs, you can create a proper service.
Running a Service
*****************
If you have a service, you need to know how to run it.
Changing How Things Look
************************
To change how songs look, we need to add or edit **themes**.
Adding More Content
-------------------
Now that you've got a mostly workable OpenLP installation, how do you get all your songs and things into OpenLP?
Importing Songs
***************
You've been using EasyWorship, this is how you get your songs out of it.
Importing a Bible
*****************
You need to be able to project Bible verses, this shows you how to get Bibles into OpenLP.
Loading a Presentation
**********************
Adding Videos and Images
************************
Getting More Out of OpenLP
--------------------------
Using the Web Remote
********************
Slide Shows
***********
Backing Tracks
**************
Finding Out More
****************
View our `reference manual <http://manual.openlp.org/>`_.
Indices and tables Indices and tables