Merge pull request #1566 from mathbunnyru/asalikhov/simplify_docs_configuration

Implement docs configuration from scratch to make it simple

.readthedocs.yaml

@@ -20,8 +20,9 @@ build:
 sphinx:
   configuration: docs/conf.py
 
-# Optionally build your docs in additional formats such as PDF
+# If using Sphinx, optionally build your docs in additional formats such as PDF
-formats: all
+# formats:
+#    - pdf
 
 # Optionally declare the Python requirements required to build your docs
 python:

docs/conf.py

@@ -1,16 +1,10 @@
-#!/usr/bin/env python3
+# Configuration file for the Sphinx documentation builder.
 #
-# docker-stacks documentation build configuration file, created by
+# This file only contains a selection of the most common options. For a full
-# sphinx-quickstart on Fri Dec 29 20:32:10 2017.
+# list see the documentation:
-#
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
-# This file is execfile()d with the current directory set to its
+
-# containing dir.
+# -- Path setup --------------------------------------------------------------
-#
-# 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.
 
 # 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
@@ -20,72 +14,66 @@
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
 
-# -- General configuration ------------------------------------------------
 
-# If your documentation needs a minimal Sphinx version, state it here.
+# -- Project information -----------------------------------------------------
-#
+
-needs_sphinx = "2.1"
+project = "docker-stacks"
+copyright = "2022, Project Jupyter"
+author = "Project Jupyter"
+
+# The short X.Y version
+version = "latest"
+
+# The full version, including alpha/beta/rc tags
+release = "latest"
+
+
+# -- General configuration ---------------------------------------------------
 
 # 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"]
+extensions = []
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
-source_suffix = {
-    ".rst": "restructuredtext",
-    ".md": "markdown",
-}
-
-# The master toctree document.
-master_doc = "index"
-
-# General information about the project.
-project = "docker-stacks"
-copyright = "2018- Project Jupyter"
-author = "Project Jupyter"
-
-# 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 = "latest"
-# The full version, including alpha/beta/rc tags.
-release = "latest"
-
 # 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
+language = "en"
 
 # 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.
+# -- Options for HTML output -------------------------------------------------
-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 = "alabaster"
 
-# Theme options are theme-specific and customize the look and feel of a theme
+# Add any paths that contain custom static files (such as style sheets) here,
-# further.  For a list of options available for each theme, see the
+# relative to this directory. They are copied after the builtin static files,
-# documentation.
+# so a file named "default.css" will overwrite the builtin "default.css".
-#
+html_static_path = ["_static"]
+
+# File above was generated using sphinx 4.3.2 with this command:
+# sphinx-quickstart --project "docker-stacks" --author "Project Jupyter" -v "latest" -r "latest" -l en --no-sep --no-makefile --no-batchfile
+# These are custom options for this project
+
+extensions = ["myst_parser", "sphinx_copybutton"]
+source_suffix = {
+    ".rst": "restructuredtext",
+    ".md": "markdown",
+}
+pygments_style = "sphinx"
+
 html_theme_options = {
     "description": "Jupyter Docker Stacks",
     "fixed_sidebar": False,
@@ -96,91 +84,3 @@ html_theme_options = {
     "logo": "jupyter-logo.svg",
     "logo_text_align": "left",
 }
-
-# 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 = {
-    "**": [
-        "about.html",
-        "navigation.html",
-        "relations.html",
-        "searchbox.html",
-    ]
-}
-
-# -- Options for HTMLHelp output ------------------------------------------
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = "docker-stacksdoc"
-
-
-# -- Options for LaTeX output ---------------------------------------------
-
-latex_elements = {
-    # The paper size ('letterpaper' or 'a4paper').
-    #
-    # 'papersize': 'letterpaper',
-    # The font size ('10pt', '11pt' or '12pt').
-    #
-    # 'pointsize': '10pt',
-    # Additional stuff for the LaTeX preamble.
-    #
-    # 'preamble': '',
-    # Latex figure (float) alignment
-    #
-    # 'figure_align': 'htbp',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-#  author, documentclass [howto, manual, or own class]).
-latex_documents = [
-    (
-        master_doc,
-        "docker-stacks.tex",
-        "docker-stacks Documentation",
-        "Project Jupyter",
-        "manual",
-    ),
-]
-
-
-# -- 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, "docker-stacks", "docker-stacks Documentation", [author], 1)]
-
-
-# -- Options for Texinfo output -------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-#  dir menu entry, description, category)
-texinfo_documents = [
-    (
-        master_doc,
-        "docker-stacks",
-        "docker-stacks Documentation",
-        author,
-        "docker-stacks",
-        "One line description of project.",
-        "Miscellaneous",
-    ),
-]
-
-# -- Extension configuration ----------------------------------------------
-
-# Anchors are often dynamic
-linkcheck_anchors = False