diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..ea88050 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = ReadtheDocsSphinxTheme +SOURCEDIR = . +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/_static/Add-Report.png b/docs/_static/Add-Report.png new file mode 100644 index 0000000..d51ec5e Binary files /dev/null and b/docs/_static/Add-Report.png differ diff --git a/docs/_static/Context-1.png b/docs/_static/Context-1.png new file mode 100644 index 0000000..213817e Binary files /dev/null and b/docs/_static/Context-1.png differ diff --git a/docs/_static/Context-2.png b/docs/_static/Context-2.png new file mode 100644 index 0000000..d870826 Binary files /dev/null and b/docs/_static/Context-2.png differ diff --git a/docs/_static/Edit-Report.png b/docs/_static/Edit-Report.png new file mode 100644 index 0000000..109febd Binary files /dev/null and b/docs/_static/Edit-Report.png differ diff --git a/docs/_static/Grouped-Reports.png b/docs/_static/Grouped-Reports.png new file mode 100644 index 0000000..799810e Binary files /dev/null and b/docs/_static/Grouped-Reports.png differ diff --git a/docs/_static/Groups-1.png b/docs/_static/Groups-1.png new file mode 100644 index 0000000..a6f2641 Binary files /dev/null and b/docs/_static/Groups-1.png differ diff --git a/docs/_static/Installer.png b/docs/_static/Installer.png new file mode 100644 index 0000000..1fe9cc2 Binary files /dev/null and b/docs/_static/Installer.png differ diff --git a/docs/_static/Installer2.png b/docs/_static/Installer2.png new file mode 100644 index 0000000..6a49858 Binary files /dev/null and b/docs/_static/Installer2.png differ diff --git a/docs/_static/Installer3.png b/docs/_static/Installer3.png new file mode 100644 index 0000000..f1ffc6f Binary files /dev/null and b/docs/_static/Installer3.png differ diff --git a/docs/_static/JRI-Viewer-Admin.png b/docs/_static/JRI-Viewer-Admin.png new file mode 100644 index 0000000..69f73dd Binary files /dev/null and b/docs/_static/JRI-Viewer-Admin.png differ diff --git a/docs/_static/JRI-Viewer-Param.png b/docs/_static/JRI-Viewer-Param.png new file mode 100644 index 0000000..cc23c6f Binary files /dev/null and b/docs/_static/JRI-Viewer-Param.png differ diff --git a/docs/_static/JRI-Viewer-Reports.png b/docs/_static/JRI-Viewer-Reports.png new file mode 100644 index 0000000..c66dfd5 Binary files /dev/null and b/docs/_static/JRI-Viewer-Reports.png differ diff --git a/docs/_static/JRIViewer-Main.png b/docs/_static/JRIViewer-Main.png new file mode 100644 index 0000000..85fc81f Binary files /dev/null and b/docs/_static/JRIViewer-Main.png differ diff --git a/docs/_static/Parameter-1.png b/docs/_static/Parameter-1.png new file mode 100644 index 0000000..e4f77e6 Binary files /dev/null and b/docs/_static/Parameter-1.png differ diff --git a/docs/_static/Set-Context.png b/docs/_static/Set-Context.png new file mode 100644 index 0000000..e9f262e Binary files /dev/null and b/docs/_static/Set-Context.png differ diff --git a/docs/_static/Set-Group-Owner.png b/docs/_static/Set-Group-Owner.png new file mode 100644 index 0000000..7d25b85 Binary files /dev/null and b/docs/_static/Set-Group-Owner.png differ diff --git a/docs/_static/jri-logo-white.png b/docs/_static/jri-logo-white.png new file mode 100644 index 0000000..0b70364 Binary files /dev/null and b/docs/_static/jri-logo-white.png differ diff --git a/docs/_static/spacer.png b/docs/_static/spacer.png new file mode 100644 index 0000000..68ace9d Binary files /dev/null and b/docs/_static/spacer.png differ diff --git a/docs/_themes/sphinx_rtd_theme/__init__.py b/docs/_themes/sphinx_rtd_theme/__init__.py new file mode 100644 index 0000000..32c87c3 --- /dev/null +++ b/docs/_themes/sphinx_rtd_theme/__init__.py @@ -0,0 +1,30 @@ +""" +Sphinx Read the Docs theme. + +From https://github.com/ryan-roemer/sphinx-bootstrap-theme. +""" + +from os import path + +import sphinx + + +__version__ = '0.4.3.dev0' +__version_full__ = __version__ + + +def get_html_theme_path(): + """Return list of HTML theme paths.""" + cur_dir = path.abspath(path.dirname(path.dirname(__file__))) + return cur_dir + + +# See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package +def setup(app): + app.add_html_theme('sphinx_rtd_theme', path.abspath(path.dirname(__file__))) + + if sphinx.version_info >= (1, 8, 0): + # Add Sphinx message catalog for newer versions of Sphinx + # See http://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx.application.Sphinx.add_message_catalog + rtd_locale_path = path.join(path.abspath(path.dirname(__file__)), 'locale') + app.add_message_catalog('sphinx', rtd_locale_path) diff --git a/docs/_themes/sphinx_rtd_theme/breadcrumbs.html b/docs/_themes/sphinx_rtd_theme/breadcrumbs.html new file mode 100644 index 0000000..90cb0ff --- /dev/null +++ b/docs/_themes/sphinx_rtd_theme/breadcrumbs.html @@ -0,0 +1,82 @@ +{# Support for Sphinx 1.3+ page_source_suffix, but don't break old builds. #} + +{% if page_source_suffix %} +{% set suffix = page_source_suffix %} +{% else %} +{% set suffix = source_suffix %} +{% endif %} + +{% if meta is defined and meta is not none %} +{% set check_meta = True %} +{% else %} +{% set check_meta = False %} +{% endif %} + +{% if check_meta and 'github_url' in meta %} +{% set display_github = True %} +{% endif %} + +{% if check_meta and 'bitbucket_url' in meta %} +{% set display_bitbucket = True %} +{% endif %} + +{% if check_meta and 'gitlab_url' in meta %} +{% set display_gitlab = True %} +{% endif %} + +
diff --git a/docs/_themes/sphinx_rtd_theme/footer.html b/docs/_themes/sphinx_rtd_theme/footer.html new file mode 100644 index 0000000..3b9bcb0 --- /dev/null +++ b/docs/_themes/sphinx_rtd_theme/footer.html @@ -0,0 +1,56 @@ + + diff --git a/docs/_themes/sphinx_rtd_theme/layout.html b/docs/_themes/sphinx_rtd_theme/layout.html new file mode 100644 index 0000000..0fe6c65 --- /dev/null +++ b/docs/_themes/sphinx_rtd_theme/layout.html @@ -0,0 +1,240 @@ +{# TEMPLATE VAR SETTINGS #} +{%- set url_root = pathto('', 1) %} +{%- if url_root == '#' %}{% set url_root = '' %}{% endif %} +{%- if not embedded and docstitle %} + {%- set titlesuffix = " — "|safe + docstitle|e %} +{%- else %} + {%- set titlesuffix = "" %} +{%- endif %} +{%- set lang_attr = 'en' if language == None else (language | replace('_', '-')) %} + + + + + + {{ metatags }} + + {% block htmltitle %} +{{ _('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.') }}
+ {% endif %} + {% endif %} +{{ context|e }}
+