From 9011fcde13f98a8a154dd983fb0aef50f2a12686 Mon Sep 17 00:00:00 2001 From: Dimitri Fontaine Date: Tue, 18 Oct 2022 19:41:57 +0200 Subject: [PATCH] Clean-up docs/conf.py (remove old cruft). --- docs/conf.py | 92 +++++++++------------------------------------------- 1 file changed, 16 insertions(+), 76 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 130dc2a..3a2cbe0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -21,62 +21,34 @@ # import sys # sys.path.insert(0, os.path.abspath('.')) +# -- Project information ----------------------------------------------------- -# -- 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 = ['sphinx.ext.githubpages'] - -# 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' -source_suffix = ['.rst', '.md'] - -# The master toctree document. -master_doc = 'index' - -# General information about the project. project = 'pgloader' copyright = '2005-2022, Dimitri Fontaine' author = 'Dimitri Fontaine' -# 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 = '3.6' -# The full version, including alpha/beta/rc tags. release = '3.6.8' -# 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 +# -- General configuration ------------------------------------------------ + +# The master toctree document. +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 = [ +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] # 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 +# 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' - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = False - # -- Options for HTML output ---------------------------------------------- @@ -86,42 +58,10 @@ todo_include_todos = False #html_theme = 'alabaster' 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 = {} -html_theme_options = { - #'github_user': 'dimitri', - #'github_repo': 'pgloader', - #'description': 'your migration companion', - #'travis_button': True, - #'show_related': True, - #'sidebar_collapse': 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'] - -# 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 = { - '**': [ - 'relations.html', # needs 'show_related': True theme option to display - 'searchbox.html', - ] -} - - -# -- Options for HTMLHelp output ------------------------------------------ - -# Output file base name for HTML help builder. -htmlhelp_basename = 'pgloaderdoc' +#html_static_path = ['_static'] # -- Options for LaTeX output ---------------------------------------------