Add the JSON Schema trove classifier and make minor packaging tweaks.

Author: Julian

docs/conf.py

@@ -1,39 +1,16 @@
-# -*- coding: utf-8 -*-
-#
-# Configuration file for the Sphinx documentation builder.
-#
-# This file does only contain a selection of the most common options. For a
-# full list see the documentation:
-# http://www.sphinx-doc.org/en/master/config
-
 import importlib.metadata
 import re
 
-# -- Project information -----------------------------------------------------
-
 project = "sphinx-json-schema-spec"
 author = "Julian Berman"
 copyright = "2013, " + author
 
-# version: The short X.Y version
-# release: The full version, including alpha/beta/rc tags.
 release = importlib.metadata.version("sphinx_json_schema_spec")
 version = release.partition("-")[0]
 
-
-# -- General configuration ---------------------------------------------------
-
-# If your documentation needs a minimal Sphinx version, state it here.
-#
-# needs_sphinx = "1.0"
-
+language = "en"
 default_role = "any"
 
-primary_domain = "rst"
-
-# 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.autosectionlabel",
@@ -44,172 +21,33 @@
     "sphinx.ext.todo",
     "sphinx_json_schema_spec",
     "sphinxcontrib.spelling",
+    "sphinxext.opengraph",
 ]
 
-# 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", ".md"]
-source_suffix = ".rst"
+pygments_style = "lovelace"
+pygments_dark_style = "one-dark"
 
-# The master toctree document.
-master_doc = "index"
-
-# 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 = "en"
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = [u"_build", "Thumbs.db", ".DS_Store"]
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = "sphinx"
-
-
-# -- 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"
 
-# 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.
-#
-# 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 = {}
-
-
-# -- Options for HTMLHelp output ---------------------------------------------
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = "sphinxjsonschemaspecdoc"
-
-
-# -- 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,
-        "Sphinx JSON Schema Spec.tex",
-        project,
-        author,
-        "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,
-        project,
-        project,
-        [author],
-        1,
-    ),
-]
+def entire_domain(host):
+    return r"http.?://" + re.escape(host) + r"($|/.*)"
 
 
-# -- 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,
-        project,
-        project,
-        author,
-        project,
-        "",
-        "Miscellaneous",
-    ),
+linkcheck_ignore = [
+    entire_domain("img.shields.io"),
+    "https://github.com/python-jsonschema/sphinx-json-schema-spec/actions",
+    "https://github.com/python-jsonschema/sphinx-json-schema-spec/workflows/CI/badge.svg",  # noqa: E501
 ]
 
+# = Extensions =
 
-# -- Options for Epub output -------------------------------------------------
-
-# Bibliographic Dublin Core info.
-epub_title = project
-
-# 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 = ""
-
-# A list of files that should not be packed into the epub file.
-epub_exclude_files = ["search.html"]
-
-
-# -- Extension configuration -------------------------------------------------
-
-# -- Options for autodoc extension -------------------------------------------
-
-autodoc_default_options = {
-    "members": True,
-    "member-order": "bysource",
-}
-
-# -- Options for autosectionlabel extension ----------------------------------
+# -- autosectionlabel --
 
 autosectionlabel_prefix_document = True
 
-# -- Options for intersphinx extension ---------------------------------------
+# -- intersphinx --
 
-# Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
     "jsonschema": (
         "https://python-jsonschema.readthedocs.io/en/latest/", None,
@@ -219,16 +57,7 @@
     "sphinx": ("https://www.sphinx-doc.org/en/master/", None),
 }
 
-# -- Options for the linkcheck builder ------------------------------------
-
+# -- sphinxcontrib-spelling --
 
-def entire_domain(host):
-    return r"http.?://" + re.escape(host) + r"($|/.*)"
-
-
-linkcheck_ignore = [
-    entire_domain("codecov.io"),
-    entire_domain("img.shields.io"),
-    "https://github.com/python-jsonschema/sphinx-json-schema-spec/actions",
-    "https://github.com/python-jsonschema/sphinx-json-schema-spec/workflows/CI/badge.svg",  # noqa: E501
-]
+spelling_word_list_filename = "spelling-wordlist.txt"
+spelling_show_suggestions = True

docs/requirements.in

@@ -2,3 +2,4 @@ file:.#egg=sphinx_json_schema_spec
 furo
 sphinx>=5.1
 sphinxcontrib-spelling>5
+sphinxext-opengraph

docs/requirements.txt

@@ -14,8 +14,14 @@ certifi==2023.5.7
     # via requests
 charset-normalizer==3.1.0
     # via requests
+contourpy==1.0.7
+    # via matplotlib
+cycler==0.11.0
+    # via matplotlib
 docutils==0.20.1
     # via sphinx
+fonttools==4.39.4
+    # via matplotlib
 furo==2023.5.20
     # via -r docs/requirements.in
 idna==3.4
@@ -24,20 +30,38 @@ imagesize==1.4.1
     # via sphinx
 jinja2==3.1.2
     # via sphinx
+kiwisolver==1.4.4
+    # via matplotlib
 lxml==4.9.2
     # via sphinx-json-schema-spec
 markupsafe==2.1.2
     # via jinja2
+matplotlib==3.7.1
+    # via sphinxext-opengraph
+numpy==1.24.3
+    # via
+    #   contourpy
+    #   matplotlib
 packaging==23.1
-    # via sphinx
+    # via
+    #   matplotlib
+    #   sphinx
+pillow==9.5.0
+    # via matplotlib
 pyenchant==3.2.2
     # via sphinxcontrib-spelling
 pygments==2.15.1
     # via
     #   furo
     #   sphinx
+pyparsing==3.0.9
+    # via matplotlib
+python-dateutil==2.8.2
+    # via matplotlib
 requests==2.31.0
     # via sphinx
+six==1.16.0
+    # via python-dateutil
 snowballstemmer==2.2.0
     # via sphinx
 soupsieve==2.4.1
@@ -49,6 +73,7 @@ sphinx==7.0.1
     #   sphinx-basic-ng
     #   sphinx-json-schema-spec
     #   sphinxcontrib-spelling
+    #   sphinxext-opengraph
 sphinx-basic-ng==1.0.0b1
     # via furo
 file:.#egg=sphinx_json_schema_spec
@@ -67,5 +92,7 @@ sphinxcontrib-serializinghtml==1.1.5
     # via sphinx
 sphinxcontrib-spelling==8.0.0
     # via -r docs/requirements.in
+sphinxext-opengraph==0.8.2
+    # via -r docs/requirements.in
 urllib3==2.0.2
     # via requests