Merge pull request #24 from azmeuk/doc

Updated doc conf, and added RTD conf

Author: azmeuk

.readthedocs.yaml

@@ -0,0 +1,9 @@
+---
+version: 2
+python:
+  install:
+    - method: pip
+      path: .
+    - requirements: docs/requirements.txt
+sphinx:
+  builder: dirhtml

CHANGES.rst

@@ -28,7 +28,8 @@ Unreleased
 -   Check for ``sqlalchemy.`` to avoid matching packages with names starting
     with ``sqlalchemy`` (6237a0f_)
 -   Use SQLAlchemy's Column.doc for WTForm's Field.description (`#21`_)
--   Stopped support for python < 3.5 and added a style pre-commit hook. (`#624`_)
+-   Stopped support for python < 3.5 and added a style pre-commit hook. (`#23`_)
+-   Documentation cleanup. (`#24`_)
 
 .. _#2: https://github.com/wtforms/wtforms-sqlalchemy/pull/2
 .. _#3: https://github.com/wtforms/wtforms-sqlalchemy/pull/3
@@ -42,7 +43,8 @@ Unreleased
 .. _#17: https://github.com/wtforms/wtforms-sqlalchemy/pull/17
 .. _6237a0f: https://github.com/wtforms/wtforms-sqlalchemy/commit/6237a0f9e53ec5f22048be7f129e29f7f1c58448
 .. _#21: https://github.com/wtforms/wtforms-sqlalchemy/pull/21
-.. _#624: https://github.com/wtforms/wtforms-sqlalchemy/pull/624
+.. _#23: https://github.com/wtforms/wtforms-sqlalchemy/pull/23
+.. _#24: https://github.com/wtforms/wtforms-sqlalchemy/pull/24
 
 Version 0.1
 -----------

docs/conf.py

@@ -1,184 +1,61 @@
-#
-# WTForms-SQLAlchemy documentation build configuration file, created by
-# sphinx-quickstart on Sun Nov 10 16:35:07 2013.
-#
-# 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.
 import os
 import sys
 
-# 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.
-sys.path.insert(0, os.path.abspath(".."))
-
-# -- 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.autodoc", "sphinx.ext.doctest", "sphinx.ext.coverage"]
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ["_templates"]
+from pallets_sphinx_themes import get_version
+from pallets_sphinx_themes import ProjectLink
 
-# The suffix of source filenames.
-source_suffix = ".rst"
-
-# The encoding of source files.
-# source_encoding = 'utf-8-sig'
+sys.path.insert(0, os.path.abspath(".."))
 
-# The master toctree document.
-master_doc = "index"
+# -- Project -------------------------------------------------------------------
 
-# General information about the project.
 project = "WTForms-SQLAlchemy"
-copyright = "2014, WTForms 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 = "0.2"
-# The full version, including alpha/beta/rc tags.
-release = "0.2dev"
 
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-# language = None
+# -- General -------------------------------------------------------------------
 
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-# today = ''
-# Else, today_fmt is used as the format for a strftime call.
-# today_fmt = '%B %d, %Y'
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
+master_doc = "index"
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.viewcode",
+    "pallets_sphinx_themes",
+    "sphinx_issues",
+    "sphinxcontrib.log_cabinet",
+]
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3/", None),
+    "WTForms": ("https://wtforms.readthedocs.io/en/stable/", None),
+}
+copyright = "2020, WTForms Team"
+release, version = get_version("WTForms")
 exclude_patterns = ["_build"]
-
-# The reST default role (used for this markup: `text`) to use for all documents.
-# default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-# add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-# add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-# show_authors = False
-
-# The name of the Pygments (syntax highlighting) style to use.
 pygments_style = "sphinx"
 
-# A list of ignored prefixes for module index sorting.
-# modindex_common_prefix = []
-
-
-# -- 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 = "default"
-
-# 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 themes here, relative to this directory.
-# html_theme_path = []
-
-# The name for this set of Sphinx documents.  If None, it defaults to
-# "<project> v<release> documentation".
-# html_title = None
-
-# A shorter title for the navigation bar.  Default is the same as html_title.
-# html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-# html_logo = None
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-# html_favicon = None
-
-# 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"]
-
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-# html_last_updated_fmt = '%b %d, %Y'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-# html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-# html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-# html_additional_pages = {}
-
-# If false, no module index is generated.
-# html_domain_indices = True
-
-# If false, no index is generated.
-# html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-# html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-# html_show_sourcelink = True
-
-# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-# html_show_sphinx = True
-
-# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-# html_show_copyright = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it.  The value of this option must be the
-# base URL from which the finished HTML is served.
-# html_use_opensearch = ''
-
-# This is the file name suffix for HTML files (e.g. ".xhtml").
-# html_file_suffix = None
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = "WTForms-SQLAlchemydoc"
-
-
-# -- 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': '',
+# -- HTML ----------------------------------------------------------------------
+
+html_theme = "werkzeug"
+html_context = {
+    "project_links": [
+        ProjectLink(
+            "WTForms documentation", "https://wtforms.readthedocs.io/en/stable/"
+        ),
+        ProjectLink("PyPI Releases", "https://pypi.org/project/WTForms-SQLAlchemy/"),
+        ProjectLink("Source Code", "https://github.com/wtforms/wtforms-sqlalchemy/"),
+        ProjectLink("Discord Chat", "https://discord.gg/F65P7Z9",),
+        ProjectLink(
+            "Issue Tracker", "https://github.com/wtforms/wtforms-sqlalchemy/issues/"
+        ),
+    ]
+}
+html_sidebars = {
+    "index": ["project.html", "localtoc.html", "searchbox.html"],
+    "**": ["localtoc.html", "relations.html", "searchbox.html"],
 }
+singlehtml_sidebars = {"index": ["project.html", "localtoc.html"]}
+html_title = f"WTForms SQLAlchemy Documentation ({version})"
+html_show_sourcelink = False
+
+# -- LATEX ---------------------------------------------------------------------
 
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
     (
         "index",
@@ -188,68 +65,3 @@
         "manual",
     ),
 ]
-
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-# latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-# latex_use_parts = False
-
-# If true, show page references after internal links.
-# latex_show_pagerefs = False
-
-# If true, show URL addresses after external links.
-# latex_show_urls = False
-
-# Documents to append as an appendix to all manuals.
-# latex_appendices = []
-
-# If false, no module index is generated.
-# latex_domain_indices = True
-
-
-# -- Options for manual page output --------------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
-    (
-        "index",
-        "wtforms-sqlalchemy",
-        "WTForms-SQLAlchemy Documentation",
-        ["WTForms Team"],
-        1,
-    )
-]
-
-# If true, show URL addresses after external links.
-# man_show_urls = False
-
-
-# -- 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 = [
-    (
-        "index",
-        "WTForms-SQLAlchemy",
-        "WTForms-SQLAlchemy Documentation",
-        "WTForms Team",
-        "WTForms-SQLAlchemy",
-        "One line description of project.",
-        "Miscellaneous",
-    ),
-]
-
-# Documents to append as an appendix to all manuals.
-# texinfo_appendices = []
-
-# If false, no module index is generated.
-# texinfo_domain_indices = True
-
-# How to display URL addresses: 'footnote', 'no', or 'inline'.
-# texinfo_show_urls = 'footnote'

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = py36, py37, py38, style
+envlist = py36, py37, py38, style, docs
 
 [testenv]
 setenv =
@@ -10,3 +10,7 @@ commands = python setup.py test
 deps = pre-commit
 skip_install = true
 commands = pre-commit run --all-files --show-diff-on-failure
+
+[testenv:docs]
+deps = -r docs/requirements.txt
+commands = sphinx-build -W -b html -d {envtmpdir}/doctrees docs {envtmpdir}/html