diff --git a/docs/_static/favicon.png b/docs/_static/favicon.png deleted file mode 100644 index 12ccd94..0000000 Binary files a/docs/_static/favicon.png and /dev/null differ diff --git a/docs/_static/logo.png b/docs/_static/logo.png deleted file mode 100644 index 3afd272..0000000 Binary files a/docs/_static/logo.png and /dev/null differ diff --git a/docs/conf.py b/docs/conf.py index eaedda5..3187fbb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,149 +1,38 @@ -#!/usr/bin/env python3 -# -*- coding: utf-8 -*- -# -# Team Compass documentation build configuration file, created by -# sphinx-quickstart on Sun Dec 3 20:44:20 2017. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. +# Project information +# =================== +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information -# 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 = "Documentation Community" +author = "Documentation Team" -# -- General configuration ------------------------------------------------ +# General configuration +# ===================== +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration -# If your documentation needs a minimal Sphinx version, state it here. -# -needs_sphinx = '3.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 = ['myst_parser', 'sphinx_copybutton'] - -# 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'] - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = 'Documentation Community' -copyright = '2021, Python' -author = 'Documentation Team' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = '2021.5' -# The full version, including alpha/beta/rc tags. -release = '2021.5' - -# 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 patterns also effect to 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' - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = False - -# -- 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 = 'furo' - -# Logo -# html_logo = '_static/logo.png' -# html_favicon = '_static/favicon.png' - -# 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. -# -# This is required for the alabaster theme -# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars -# html_sidebars = { -# '**': [ -# 'navigation.html', -# 'relations.html', # needs 'show_related': True theme option to display -# 'searchbox.html', -# 'donate.html', -# ] -# } - - -# -- Options for HTMLHelp output ------------------------------------------ - -# Output file base name for HTML help builder. -htmlhelp_basename = 'Docscommunitydoc' - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, 'docscommunity', 'Docs Community Documentation', - [author], 1) +# A list of strings that are module names of Sphinx extensions +extensions = [ + "sphinx_copybutton", + "myst_parser", ] +# The master toctree document +master_doc = "index" -# -- Options for Epub output ---------------------------------------------- +# Patterns to exclude during source file detetection +exclude_patterns = [ + "_build", + "Thumbs.db", + ".DS_Store", +] -# Bibliographic Dublin Core info. -epub_title = project -epub_author = author -epub_publisher = author -epub_copyright = copyright +# Minimum Sphinx version as a string +needs_sphinx = "4.0" -# The unique identifier of the text. This can be a ISBN number -# or the project homepage. -# -# epub_identifier = '' -# A unique identification for the text. -# -# epub_uid = '' +# Options for HTML output +# ======================= +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -# A list of files that should not be packed into the epub file. -epub_exclude_files = ['search.html'] +# The theme to use for HTML pages +html_theme = "furo"