Update docs (#209)

get docs build working again

.readthedocs.yaml

@@ -0,0 +1,13 @@
+version: 2
+build:
+  os: ubuntu-22.04
+  tools:
+    python: '3.12'
+python:
+  install:
+    - requirements: requirements/docs.txt
+    - method: pip
+      path: .
+sphinx:
+  builder: dirhtml
+  fail_on_warning: true

docs/conf.py

@@ -17,13 +17,16 @@
 # 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(".."))
-sys.path.append(os.path.abspath("_themes"))
 
 # -- 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 = ["sphinx.ext.autodoc", "sphinx.ext.intersphinx"]
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "pallets_sphinx_themes",
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
@@ -87,110 +90,11 @@
 # A list of ignored prefixes for module index sorting.
 # modindex_common_prefix = []
 
+# HTML -----------------------------------------------------------------
 
-# -- Options for HTML output ---------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages.  Major themes that come with
-# Sphinx are currently 'default' and 'sphinxdoc'.
-html_theme = "flask_small"
-# html_theme = 'default'
-html_theme_options = {"index_logo": "flask-mail.png", "github_fork": None}
-
-# 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 = ["_themes"]
-
-# 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_theme = "flask"
 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_use_modindex = 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, 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 = ''
-
-# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
-# html_file_suffix = ''
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = "flask-maildoc"
-
-
-# -- Options for LaTeX output --------------------------------------------------
-
-# The paper size ('letter' or 'a4').
-# latex_paper_size = 'letter'
-
-# The font size ('10pt', '11pt' or '12pt').
-# latex_font_size = '10pt'
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass [howto/manual]).
-latex_documents = [
-    ("index", "flask-mail.tex", "flask-mail Documentation", "Dan Jacob", "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
-
-# Additional stuff for the LaTeX preamble.
-# latex_preamble = ''
-
-# Documents to append as an appendix to all manuals.
-# latex_appendices = []
-
-# If false, no module index is generated.
-# latex_use_modindex = True
+html_copy_source = False
+html_show_copyright = False
+html_use_index = False
+html_domain_indices = False

docs/index.rst

@@ -12,9 +12,9 @@ The **Flask-Mail** extension provides a simple interface to set up SMTP with you
 Links
 -----
 
-* `documentation <http://packages.python.org/Flask-Mail/>`_
-* `source <http://github.com/mattupstate/flask-mail>`_
-* :doc:`changelog </changelog>`
+* `documentation <https://flask-mail.readthedocs.io/en/latest/>`_
+* `source <http://github.com/pallets-eco/flask-mail>`_
+* :doc:`changes </changes>`
 
 Installing Flask-Mail
 ---------------------
@@ -251,3 +251,9 @@ API
 
 .. _Flask: http://flask.pocoo.org
 .. _GitHub: http://github.com/mattupstate/flask-mail
+
+
+.. toctree::
+   :maxdepth: 2
+
+   changes

requirements/docs.in

@@ -0,0 +1,3 @@
+pallets-sphinx-themes
+sphinx
+sphinxcontrib-log-cabinet

requirements/docs.txt

@@ -0,0 +1,63 @@
+#
+# This file is autogenerated by pip-compile with Python 3.8
+# by the following command:
+#
+#    pip-compile docs.in
+#
+alabaster==0.7.13
+    # via sphinx
+babel==2.15.0
+    # via sphinx
+certifi==2024.2.2
+    # via requests
+charset-normalizer==3.3.2
+    # via requests
+docutils==0.20.1
+    # via sphinx
+idna==3.7
+    # via requests
+imagesize==1.4.1
+    # via sphinx
+importlib-metadata==7.1.0
+    # via sphinx
+jinja2==3.1.4
+    # via sphinx
+markupsafe==2.1.5
+    # via jinja2
+packaging==24.0
+    # via
+    #   pallets-sphinx-themes
+    #   sphinx
+pallets-sphinx-themes==2.1.3
+    # via -r docs.in
+pygments==2.18.0
+    # via sphinx
+pytz==2024.1
+    # via babel
+requests==2.32.0
+    # via sphinx
+snowballstemmer==2.2.0
+    # via sphinx
+sphinx==7.1.2
+    # via
+    #   -r docs.in
+    #   pallets-sphinx-themes
+    #   sphinxcontrib-log-cabinet
+sphinxcontrib-applehelp==1.0.4
+    # via sphinx
+sphinxcontrib-devhelp==1.0.2
+    # via sphinx
+sphinxcontrib-htmlhelp==2.0.1
+    # via sphinx
+sphinxcontrib-jsmath==1.0.1
+    # via sphinx
+sphinxcontrib-log-cabinet==1.0.1
+    # via -r docs.in
+sphinxcontrib-qthelp==1.0.3
+    # via sphinx
+sphinxcontrib-serializinghtml==1.1.5
+    # via sphinx
+urllib3==2.2.1
+    # via requests
+zipp==3.18.2
+    # via importlib-metadata

tox.ini

@@ -23,6 +23,10 @@ deps = pre-commit
 skip_install = true
 commands = pre-commit run --all-files
 
+[testenv:docs]
+deps = -r requirements/docs.txt
+commands = sphinx-build -E -W -b dirhtml docs docs/_build/dirhtml
+
 [testenv:update-pre_commit]
 labels = update
 deps = pre-commit
@@ -38,4 +42,5 @@ change_dir = requirements
 commands =
     pip-compile build.in -q {posargs:-U}
     pip-compile dev.in -q {posargs:-U}
+    pip-compile docs.in -q {posargs:-U}
     pip-compile tests.in -q {posargs:-U}