setup digital audio service

Author: tmosch

english/conf.py

@@ -1,3 +1,5 @@
+## setup -> pip3 install -r requirements.txt
+
 # -*- coding: utf-8 -*-
 #
 # streamABC documentation build configuration file, created by
@@ -19,7 +21,9 @@
 # import os
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
-
+import sys
+from datetime import datetime
+from os import path
 
 # -- General configuration ------------------------------------------------
 
@@ -31,7 +35,16 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 # extensions = ['sphinx.ext.githubpages']
-extensions = []
+extensions = [
+    'hoverxref.extension',
+    'notfound.extension',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.coverage',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.autosectionlabel'
+]
+autosectionlabel_prefix_document = True
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -47,7 +60,7 @@
 
 # General information about the project.
 project = u'QuantumCast'
-copyright = u'2020, QuantumCast'
+copyright = f'2019–{datetime.now().year}, QuantumCast, '
 author = u'QuantumCast'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -64,13 +77,13 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
-
+exclude_trees = ['.build']
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
@@ -85,7 +98,9 @@
 #
 #html_theme = 'alabaster'
 html_theme = 'sphinx_rtd_theme'
-html_theme_path = ["themes"]
+#html_theme_path = ["themes"]
+import sphinx_rtd_theme
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # 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
@@ -97,7 +112,7 @@
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
-
+html_last_updated_fmt = '%b %d, %Y'
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
 #
@@ -171,4 +186,32 @@
 ]
 
 
+# Options for the InterSphinx extension
+# -------------------------------------
+
+intersphinx_mapping = {
+    'attrs': ('https://www.attrs.org/en/stable/', None),
+    'coverage': ('https://coverage.readthedocs.io/en/stable', None),
+    'cssselect': ('https://cssselect.readthedocs.io/en/latest', None),
+    'itemloaders': ('https://itemloaders.readthedocs.io/en/latest/', None),
+    'pytest': ('https://docs.pytest.org/en/latest', None),
+    'python': ('https://docs.python.org/3', None),
+    'sphinx': ('https://www.sphinx-doc.org/en/master', None),
+    'tox': ('https://tox.readthedocs.io/en/latest', None),
+    'twisted': ('https://twistedmatrix.com/documents/current', None),
+    'twistedapi': ('https://twistedmatrix.com/documents/current/api', None),
+}
+
+# Options for sphinx-hoverxref options
+# ------------------------------------
+
+hoverxref_auto_ref = True
+hoverxref_role_types = {
+    "class": "tooltip",
+    "confval": "tooltip",
+    "hoverxref": "tooltip",
+    "mod": "tooltip",
+    "ref": "tooltip",
+}
+hoverxref_roles = ['command', 'reqmeta', 'setting', 'signal']
 

english/digital-audio-services/index.rst

@@ -0,0 +1,48 @@
+
+.. _topics-index:
+
+==============================================
+Audio Backend Services |version| documentation
+==============================================
+
+
+Cloud computing has become an integral part of businesses across all industries. 
+ABS is the first Audio cloud computing platform.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Networking and Content Delivery
+   :hidden:
+
+   topics/streamroute
+
+
+:doc:`topics/streamroute`
+    Service for effectively connects user stream requests
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+----
+
+For more information, please open a ticket: |helpdesk|
+
+Visit our company website: |www.quantumcast-digital.com|
+
+
+
+.. |helpdesk| raw:: html
+
+    <a href="https://streamabc.zammad.com" target="_blank">https://streamabc.zammad.com</a>
+
+
+.. |www.quantumcast-digital.com| raw:: html
+
+   <a href="https://www.quantumcast-digital.com/" target="_blank">www.quantumcast-digital.com</a>
+   

english/streamroute.rst renamed to english/digital-audio-services/topics/streamroute.rst

@@ -16,13 +16,6 @@ The QuantumCast documentation is organized into several sections:
 (more coming soon)
 
 
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Digital Audio Services
-
-   streamroute
-
 .. _distributor-docs:
 
 .. toctree::

english/index.rst

@@ -0,0 +1,4 @@
+Sphinx>=3.0
+sphinx-hoverxref>=0.2b1
+sphinx-notfound-page>=0.4
+sphinx_rtd_theme>=0.5