--- a +++ b/docs/conf.py @@ -0,0 +1,72 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.Ntml + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = 'QuArray' +copyright = '2020, Callum Arthurs' +author = 'Callum Arthurs' + +# The full version, including alpha/beta/rc tags +release = '0.6' + + +# -- General configuration --------------------------------------------------- + +master_doc = 'index' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = ['sphinxext.opengraph'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['ntemplates'] + +# 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'] + + +# -- 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 = 'alabaster' +html_theme = 'sphinx_rtd_theme' + +# Theme options +html_theme_options = { + # if we have a html_logo below, this shows /only/ the logo with no title text + "logo_only": True, + # Collapse navigation (False makes it tree-like) + "collapse_navigation": False, +} + +# 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'] + +html_logo = "images/icon.png" +html_favicon = "../scripts/icons/icon.ico" +ogp_image = "https://quarray.readthedocs.io/en/latest/_static/icon.png" +# ogp_custom_meta_tags = [ +# '<meta name="image" property="og:image" content="[https://quarray.readthedocs.io/en/latest/_static/icon.png]/>', +# ]