Initial commit

.editorconfig

@@ -0,0 +1,23 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+end_of_line = lf
+charset = utf-8
+max_line_length = 80
+indent_style = space
+indent_size = 4
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.html]
+indent_size = 2
+max_line_length = off
+
+[*.py]
+max_line_length = 79
+
+[*.yml]
+indent_size = 2
+max_line_length = off

.gitignore

@@ -0,0 +1,4 @@
+/build/
+/dist/
+/src/insipid_sphinx_theme.egg-info/
+__pycache__/

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "Font-Awesome"]
+	path = Font-Awesome
+	url = https://github.com/FortAwesome/Font-Awesome.git

.readthedocs.yml

@@ -0,0 +1,14 @@
+version: 2
+build:
+  image: latest
+submodules:
+  include: all
+python:
+  version: 3
+  install:
+    - requirements: doc/requirements.txt
+    - method: pip
+      path: .
+  system_packages: true
+formats:
+  - htmlzip

LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2020, Matthias Geier
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

MANIFEST.in

@@ -0,0 +1,6 @@
+include LICENSE
+include *.rst
+include doc/conf.py
+include doc/requirements.txt
+recursive-include doc *.rst *.png *.ico *.svg
+recursive-include doc/_templates *.html

README.rst

@@ -0,0 +1,24 @@
+An Insipid Sphinx_ Theme
+========================
+
+.. _Sphinx: https://www.sphinx-doc.org/
+
+Quick Start
+    #. Install the Python package ``insipid-sphinx-theme``
+    #. Add ``html_theme = 'insipid'`` to your ``conf.py``
+    #. Run Sphinx!
+
+Online documentation (and example of use)
+    https://insipid-sphinx-theme.readthedocs.io/
+
+Source code repository (and issue tracker)
+    https://github.com/mgeier/insipid-sphinx-theme/
+
+License
+    BSD-2-Clause (same as Sphinx itself),
+    for more information take a look at the ``LICENSE`` file.
+
+    SVG icons from `Font Awesome`__, `CC BY 4.0`__.
+
+    __ https://fontawesome.com/
+    __ https://creativecommons.org/licenses/by/4.0/

doc/_templates/github-badge.html

@@ -0,0 +1,3 @@
+<p>
+<iframe src="https://ghbtns.com/github-btn.html?user=mgeier&repo=insipid-sphinx-theme&type=star&count=true&size=large" frameborder="0" scrolling="0" width="160px" height="30px"></iframe>
+</p>

doc/conf.py

@@ -0,0 +1,158 @@
+# Configuration file for Sphinx,
+# see https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Recommended settings -----------------------------------------------------
+
+html_theme = 'insipid'
+
+# Set to empty string to disable links to sections
+html_add_permalinks = '\N{SECTION SIGN}'
+
+# -- Recommended settings for readthedocs.org ---------------------------------
+
+# If False, source links to Bitbucket/Github/GitLab are shown
+html_copy_source = False
+
+# -- Settings for source code -------------------------------------------------
+
+# Language used for syntax highlighting (default: 'python')
+#highlight_language = 'none'
+
+# Style of syntax highlighting
+#pygments_style = 'monokai'
+
+# -- Language settings --------------------------------------------------------
+
+#language = 'es'
+
+# Date format used in footer. Use empty string for (language-specific) default.
+# 'sphinx_last_updated_by_git' extension provides modification dates per page.
+#html_last_updated_fmt = '%Y-%m-%d %H:%M:%S %Z'
+
+# -- Theme configuration ------------------------------------------------------
+
+html_theme_options = {
+    #'body_centered': False,
+    #'body_max_width': None,
+    #'breadcrumbs': True,
+    #'globaltoc_collapse': False,
+    #'globaltoc_includehidden': True,
+    #'left_buttons': [
+    #],
+    #'navigation_with_keys': False,
+    #'nosidebar': True,
+    #'right_buttons': [
+    #    'search-button.html',
+    #],
+    #'rightsidebar': True,
+    #'show_insipid': False,
+    #'sidebar_overlay_width': None,
+    #'sidebar_transition': '1s ease-out',
+    #'sidebarwidth': '10rem',
+    #'strip_section_numbers': False,
+    #'topbar_transition': '1.5s ease-out',
+}
+
+html_sidebars = {
+   '**': [
+       'github-badge.html',  # Custom template, see _templates/
+       'globaltoc.html',
+       'separator.html',
+       'indices.html',
+   ],
+   'showcase/no-sidebar': [],  # To demonstrate a page without a sidebar
+}
+
+html_static_path = ['_static']
+templates_path = ['_templates']
+
+# -- Project information ------------------------------------------------------
+
+project = 'insipid-sphinx-theme'
+#html_title = 'Insipid Sphinx Theme'
+html_short_title = 'insipid'
+#copyright = '<insert year and copyright holder>'
+#version = '3.14'
+#release = '3.14.dev2'
+
+html_logo = 'showcase/insipid.png'
+html_favicon = '_static/favicon.svg'
+
+# -- Page footer --------------------------------------------------------------
+
+html_show_copyright = False
+#html_show_sphinx = False
+#html_show_sourcelink = False
+
+# Only relevant when html_copy_source is True
+#html_sourcelink_suffix = ''
+
+# -- Miscellaneous settings ---------------------------------------------------
+
+# Numbered figures, tables and code-blocks
+numfig = True
+
+html_secnumber_suffix = '\N{FIGURE SPACE}'
+
+#html_compact_lists = False
+
+#smartquotes = False
+
+# Generate alphabetic index
+#html_use_index = False
+
+# Separate page per starting letter
+#html_split_index = True
+
+# Generate domain indices, e.g. Python module index
+#html_domain_indices = False
+
+# -- Sphinx extensions --------------------------------------------------------
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.viewcode',
+    'sphinx_last_updated_by_git',
+]
+
+intersphinx_mapping = {
+    'sphinx': ('https://www.sphinx-doc.org/', None),
+}
+
+# -- Get version information from Git -----------------------------------------
+
+try:
+    from subprocess import check_output
+    release = check_output(['git', 'describe', '--tags', '--always'])
+    release = release.decode().strip()
+except Exception:
+    release = '<unknown>'
+
+# -- Define custom directives/roles -------------------------------------------
+
+
+def gh_template_role(rolename, rawtext, text, lineno, inliner,
+                     options={}, content=()):
+    from docutils import nodes, utils
+    github_url = 'https://github.com/mgeier/insipid-sphinx-theme'
+    blob_url = github_url + '/blob/' + release
+    base_url = blob_url + '/src/insipid_sphinx_theme/insipid/%s'
+    text = utils.unescape(text)
+    full_url = base_url % text
+    pnode = nodes.reference(internal=False, refuri=full_url)
+    pnode += nodes.literal(text, text, classes=['file'])
+    return [pnode], []
+
+
+def setup(app):
+    app.add_object_type(
+        'confval', 'confval',
+        objname='Sphinx configuration value',
+        indextemplate='pair: %s; Sphinx configuration value')
+    app.add_object_type(
+        'theme-option', 'theme-option',
+        objname='Theme option',
+        indextemplate='pair: %s; Theme option')
+    app.add_role('gh-template', gh_template_role)