git - Merge pull request #98 from DinoTools/type_hints

Add type hints
DinoTools · Apr 27, 2021 · 5343e74 · 5343e74
2 parents a4f62cf + 0ba3f85
commit 5343e74
Show file tree

Hide file tree

Showing 8 changed files with 310 additions and 261 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,19 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/source/conf.py
+
+# Optionally build your docs in additional formats such as PDF
+formats: all
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+   version: 3.7
+   install:
+   - requirements: docs/requirements.txt
diff --git a/README.rst b/README.rst
@@ -33,7 +33,7 @@ Install
 
 Supported Python versions:
 
-* Python >= 3.6
+* Python >= 3.6.2
 * PyPy3
 
 **Install:**

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,2 @@
+sphinx
+sphinx-autodoc-typehints
diff --git a/docs/source/_static/.keep b/docs/source/_static/.keep
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -7,7 +7,6 @@
 import sys
 from pathlib import Path
 
-from overpy import __about__ as overpy_about
 
 # 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
@@ -25,6 +24,7 @@
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
+    'sphinx_autodoc_typehints',
     'sphinx.ext.todo',
     'sphinx.ext.coverage',
     'sphinx.ext.viewcode',
@@ -50,10 +50,15 @@
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
-# The short X.Y version.
-version = overpy_about.__version__
-# The full version, including alpha/beta/rc tags.
-release = overpy_about.__version__
+try:
+    from overpy import __about__ as overpy_about
+    # The short X.Y version.
+    version = overpy_about.__version__
+    # The full version, including alpha/beta/rc tags.
+    release = overpy_about.__version__
+except ImportError:
+    version = "unknown"
+    release = version
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -93,6 +98,9 @@
 # If true, keep warnings as "system message" paragraphs in the built documents.
 #keep_warnings = False
 
+# sphinx-autodoc-typehints options
+# If True, add stub documentation for undocumented parameters to be able to add type info.
+always_document_param_types = True
 
 # -- Options for HTML output ----------------------------------------------