fix docs building

Author: tomato42

.readthedocs.yaml

@@ -0,0 +1,23 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+  - requirements: requirements.txt
+  - requirements: docs/requirements.txt

docs/conf.py

@@ -20,7 +20,24 @@
 import sys
 sys.path.insert(0, os.path.abspath('..'))
 
-# -- General configuration ------------------------------------------------
+
+# -- Project information -----------------------------------------------------
+
+project = u'tlslite-ng'
+copyright = u'2023, Hubert Kario'
+author = u'Hubert Kario'
+
+# 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 = u'0.8'
+# The full version, including alpha/beta/rc tags.
+release = u'0.8.0-beta1'
+
+
+# -- General configuration ---------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
 #
@@ -32,6 +49,9 @@
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.intersphinx',
+    'sphinx.ext.coverage',
+    'sphinx.ext.imgmath',
+    'sphinx.ext.viewcode',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -50,26 +70,12 @@
 # The master toctree document.
 master_doc = 'index'
 
-# General information about the project.
-project = u'tlslite-ng'
-copyright = u'2023, Hubert Kario'
-author = u'Hubert Kario'
-
-# 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 = u'0.8'
-# The full version, including alpha/beta/rc tags.
-release = u'0.8.0-beta1'
-
 # 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"
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
@@ -320,7 +326,7 @@
 #  dir menu entry, description, category)
 texinfo_documents = [
     (master_doc, 'tlslite-ng', u'tlslite-ng Documentation',
-     author, 'tlslite-ng', 'One line description of project.',
+     author, 'tlslite-ng', 'Pure python implementation of TLS.',
      'Miscellaneous'),
 ]
 

docs/requirements.txt

@@ -0,0 +1 @@
+sphinx-rtd-theme