docs(rtd): use conf.py to add custom css

myii · myii · commit cb94e3b5b1ce · 2019-03-01T06:11:10.000Z
diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css
@@ -0,0 +1,18 @@
+/*
+    Override styles for in-use Sphinx theme
+*/
+
+/* override table width restrictions */
+.wy-table-responsive table th
+, .wy-table-responsive table td
+{
+    /* !important prevents the common CSS stylesheets from
+       overriding this as on RTD they are loaded after this stylesheet */
+    white-space: normal !important;
+}
+
+.wy-table-responsive
+{
+    overflow: visible !important;
+}
+
diff --git a/docs/conf.py b/docs/conf.py
@@ -0,0 +1,116 @@
+# -*- coding: utf-8 -*-
+"""Configuration file for the Sphinx documentation builder.
+
+This file does only contain a selection of the most common options. For a
+full list see the documentation:
+
+* http://www.sphinx-doc.org/en/stable/config
+
+"""
+
+# -- Project information -----------------------------------------------------
+
+# project = 'template-formula'
+# copyright = __copyright__.replace('Copyright ', '').replace('(C) ', '')  # noqa: A001
+# author = __author__
+#
+# # Currently have 3 options about how to display the `version`.
+# # All 3 are available below, with 2 of them disabled.
+# # The short X.Y version
+# # major, minor, micro = parse(__version__).base_version.split('.')
+# # version = f'{major}.{minor}'
+# # The short X.Y.Z version
+# version = parse(__version__).base_version
+# # The full version, including alpha/beta/rc tags
+# # version = __version__
+# release = __version__
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+# extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+# templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+# source_suffix = '.rst'
+
+# The master toctree document.
+# master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# 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
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path .
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+# pygments_style = 'sphinx'
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+# html_theme = 'sphinx_rtd_theme'
+
+# 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 static files (such as style sheets) here,
+# 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']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Functions: `setup`, docstring preprocessing, etc. -----------------------
+
+def setup(app):
+    """Prepare the Sphinx application object.
+
+    Used for providing a custom CSS file for override styles.
+
+    Parameters
+    ----------
+    app : object
+        The Sphinx application object.
+
+    Returns
+    -------
+    app : object
+        The Sphinx application object.
+
+    """
+    app.add_stylesheet('css/custom.css')
+    return app
