dev: Update sphinx and readthedocs config

* Update sphinx config to work with new build backend.
* Add explicit Read the Docs configuration file

Author: bd808

.readthedocs.yaml

@@ -0,0 +1,12 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+sphinx:
+  configuration: docs/conf.py
+  fail_on_warning: true

doc/_static/.gitkeep docs/_static/.gitkeepdoc/_static/.gitkeep renamed to docs/_static/.gitkeep

@@ -1,18 +1,10 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
-
 import datetime
-import os
-import subprocess
-import sys
+import importlib.metadata
 
 import sphinx_rtd_theme
 
-if 'check_output' not in dir(subprocess):
-    import subprocess32 as subprocess
-
-sys.path.insert(0, os.path.abspath('../'))
-
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.intersphinx',
@@ -25,18 +17,15 @@
 }
 
 # General information about the project.
-root = os.path.join(os.path.dirname(__file__), '..')
-setup_script = os.path.join(root, 'setup.py')
-fields = ['--name', '--version', '--author']
-dist_info_cmd = [sys.executable, setup_script] + fields
-output_bytes = subprocess.check_output(dist_info_cmd, cwd=root)
-project, version, author = output_bytes.decode('utf-8').strip().split('\n')
+metadata = importlib.metadata.metadata("ib3")
+project = metadata["name"]
+version = metadata["version"]
+author = "Bryan Davis"
 
 _origin_date = datetime.date(2017, 2, 19)
 _today = datetime.date.today()
 
-copyright = '{_origin_date.year}-{_today.year} {author}'.format(**locals())
-
+copyright = f'{_origin_date.year}-{_today.year} {author} and contributors'
 release = version
 
 master_doc = 'index'

doc/about.rst docs/about.rstdoc/about.rst renamed to docs/about.rst

@@ -6,7 +6,7 @@ IRC bot framework using mixins to provide commonly desired functionality.
 .. image:: https://img.shields.io/pypi/v/ib3.svg
    :target: https://pypi.org/project/ib3
 
-.. image:: https://img.shields.io/github/actions/workflow/status/bd808/python-ib3/tox.yml?logo=github&style=for-the-badge
+.. image:: https://img.shields.io/github/actions/workflow/status/bd808/python-ib3/tox.yml?logo=github
    :target: https://github.com/bd808/python-ib3/actions/workflows/tox.yml
 
 .. image:: https://readthedocs.org/projects/python-ib3/badge/?version=latest

doc/conf.py docs/conf.pydoc/conf.py renamed to docs/conf.py

@@ -20,7 +20,8 @@ deps=
     sphinx
     sphinx_rtd_theme
 commands=
-    sphinx-build -q -W -b html -d {envtmpdir}/doctrees doc {envtmpdir}/html
+    sphinx-build -q -W -b html -d "{envtmpdir}{/}doctree" docs "{toxinidir}{/}dist{/}docs"
+    python -c 'print(r"documentation available under file://{toxinidir}{/}dist{/}docs{/}index.html")'
 
 [testenv:pkg_meta]
 description = check that generated pacakges are valid