Changeset View
Changeset View
Standalone View
Standalone View
source/conf.py
Show First 20 Lines • Show All 120 Lines • ▼ Show 20 Lines | |||||
# The name of the Pygments (syntax highlighting) style to use. | # The name of the Pygments (syntax highlighting) style to use. | ||||
pygments_style = 'sphinx' | pygments_style = 'sphinx' | ||||
# A list of ignored prefixes for module index sorting. | # A list of ignored prefixes for module index sorting. | ||||
#modindex_common_prefix = [] | #modindex_common_prefix = [] | ||||
# -- Options for HTML output --------------------------------------------------- | # -- Options for HTML output --------------------------------------------------- | ||||
#import sphinx_rtd_theme | |||||
#html_theme = "sphinx_rtd_theme" | |||||
#html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] | |||||
# The theme to use for HTML and HTML Help pages. See the documentation for | |||||
# a list of builtin themes. | |||||
html_theme = 'sphinxdoc' | html_theme = 'sphinxdoc' | ||||
# Theme options are theme-specific and customize the look and feel of a theme | |||||
# further. For a list of options available for each theme, see the | |||||
# documentation. | |||||
#html_theme_options = {} | |||||
# Add any paths that contain custom themes here, relative to this directory. | |||||
html_theme_path = ['themes'] | html_theme_path = ['themes'] | ||||
# 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 = 'Kolab Groupware documentation' | html_title = 'Kolab Groupware documentation' | ||||
# 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 = 'Kolab documentation' | html_short_title = 'Kolab documentation' | ||||
▲ Show 20 Lines • Show All 208 Lines • ▼ Show 20 Lines | |||||
# add default tags if no custom ones defined | # add default tags if no custom ones defined | ||||
if not custom_tags: | if not custom_tags: | ||||
for tag in default_tags: | for tag in default_tags: | ||||
tags.add(tag) | tags.add(tag) | ||||
# add variables as substitutions to the head of each page | # add variables as substitutions to the head of each page | ||||
rst_prolog = "" | rst_prolog = "" | ||||
for var,repl in variables.items(): | for var, repl in variables.items(): | ||||
rst_prolog += " .. |%s| replace:: %s\n" % (var, repl) | rst_prolog += " .. |%s| replace:: %s\n" % (var, repl) | ||||
rst_prolog += " .. |**%s**| replace:: **%s**\n" % (var, repl) | rst_prolog += " .. |**%s**| replace:: **%s**\n" % (var, repl) | ||||
# forward variables for substitutions in fancyfigures | # forward variables for substitutions in fancyfigures | ||||
fancyfigure_variables = variables | fancyfigure_variables = variables | ||||
extlinks = { | extlinks = { | ||||
'rfc': ('http://tools.ietf.org/html/rfc%s', 'RFC '), | 'rfc': ('http://tools.ietf.org/html/rfc%s', 'RFC '), | ||||
'mock': ('https://git.kolab.org/T%s', 'Mock #'), | 'mock': ('https://git.kolab.org/T%s', 'Mock #'), | ||||
'task': ('https://git.kolab.org/T%s', 'Task #'), | 'task': ('https://git.kolab.org/T%s', 'Task #'), | ||||
} | } | ||||
rst_prolog += """ | rst_prolog += """ | ||||
.. _Architecture & Design: https://git.kolab.org/tag/architecture_design/ | .. _Architecture & Design: https://git.kolab.org/tag/architecture_design/ | ||||
.. _bugzilla: https://issues.kolab.org/ | |||||
.. _current sprint: https://git.kolab.org/tag/sprint_current/ | |||||
.. _next sprint: https://git.kolab.org/tag/sprint_next/ | |||||
.. _Differential: https://git.kolab.org/differential/ | .. _Differential: https://git.kolab.org/differential/ | ||||
.. _Diffusion: https://git.kolab.org/diffusion/ | .. _Diffusion: https://git.kolab.org/diffusion/ | ||||
.. _Drydock: https://git.kolab.org/drydock/ | .. _Drydock: https://git.kolab.org/drydock/ | ||||
.. _EPEL for Enterprise Linux 6: http://download.fedoraproject.org/pub/epel/6/x86_64/repoview/epel-release.html | .. _EPEL for Enterprise Linux 6: http://download.fedoraproject.org/pub/epel/6/x86_64/repoview/epel-release.html | ||||
.. _EPEL for Enterprise Linux 7: http://download.fedoraproject.org/pub/epel/7/x86_64/repoview/epel-release.html | .. _EPEL for Enterprise Linux 7: http://download.fedoraproject.org/pub/epel/7/x86_64/repoview/epel-release.html | ||||
.. _Harbormaster: https://git.kolab.org/harbormaster/ | .. _Harbormaster: https://git.kolab.org/harbormaster/ | ||||
.. _Herald: https://git.kolab.org/herald/ | .. _Herald: https://git.kolab.org/herald/ | ||||
.. _Kolab Systems AG: https://kolabsystems.com | .. _Kolab Systems AG: https://kolabsystems.com | ||||
.. _Maniphest: https://git.kolab.org/maniphest/ | .. _Maniphest: https://git.kolab.org/maniphest/ | ||||
.. _Phabricator: https://git.kolab.org/ | .. _Phabricator: https://git.kolab.org/ | ||||
.. _Process Managers: https://git.kolab.org/tag/process_managers/ | .. _Process Managers: https://git.kolab.org/tag/process_managers/ | ||||
.. _Product Owners: https://git.kolab.org/tag/product_owners/ | .. _Product Owners: https://git.kolab.org/tag/product_owners/ | ||||
.. _Projects: https://git.kolab.org/projects/ | .. _Projects: https://git.kolab.org/projects/ | ||||
.. _Quality Assurance: https://git.kolab.org/tag/quality_assurance/ | .. _Quality Assurance: https://git.kolab.org/tag/quality_assurance/ | ||||
.. _Report a bug: https://git.kolab.org/maniphest/task/edit/form/9/ | |||||
.. _Scrum: http://en.wikipedia.org/wiki/Scrum_%28software_development%29 | |||||
.. _Scrum Masters: https://git.kolab.org/tag/process_managers/ | .. _Scrum Masters: https://git.kolab.org/tag/process_managers/ | ||||
.. _Sprints: https://git.kolab.org/project/sprint/ | .. _Sprints: https://git.kolab.org/project/sprint/ | ||||
.. _Why Your System Should Have a Proper FQDN: https://kanarip.wordpress.com/2016/02/04/why-your-system-requires-a-proper-fqdn/ | .. _Why Your System Should Have a Proper FQDN: https://kanarip.wordpress.com/2016/02/04/why-your-system-requires-a-proper-fqdn/ | ||||
""" | """ | ||||
# | |||||
# Releases | |||||
# | |||||
rst_prolog += """ | |||||
.. |Winterfell| replace:: :orange:`Winterfell` | |||||
.. |K16| replace:: :orange:`Kolab 16` | |||||
.. |KE14| replace:: :orange:`Kolab Enterprise 14` | |||||
.. |KE13| replace:: :orange:`Kolab Enterprise 13` | |||||
""" | |||||
# | |||||
# Target platforms | |||||
# | |||||
rst_prolog += """ | |||||
.. |maipo| replace:: :gray:`Maipo` | |||||
.. |santiago| replace:: :gray:`Santiago` | |||||
""" | |||||
# | |||||
# Packages | |||||
# | |||||
rst_prolog += """ | |||||
.. |roundcubemail| replace:: :blue:`roundcubemail` | |||||
.. |roundcubemail-plugins-kolab| replace:: :blue:`roundcubemail-plugins-kolab` | |||||
""" | |||||
rst_prolog += """ | |||||
>>>>>>> A contributor guide to Kolab | |||||
.. role:: blue | |||||
.. role:: gray | |||||
.. role:: green | |||||
.. role:: orange | |||||
.. role:: red | |||||
""" |