add changelog, misc docs fixes, bump to 0.1.0.post0

svenevs · May 16, 2019 · cf8f6ef · cf8f6ef
1 parent 0689f9a
commit cf8f6ef
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 3 deletions.
diff --git a/ci_exec/__init__.py b/ci_exec/__init__.py
@@ -13,7 +13,13 @@
 # See the License for the specific language governing permissions and                  #
 # limitations under the License.                                                       #
 ########################################################################################
-"""The ``ci_exec`` package top-level namespace."""
+"""
+The ``ci_exec`` package top-level namespace.
+
+Quick Reference:
+
+.. coresummary::
+"""
 
 # Import the core utilities in the ci_exec "namespace" for simpler imports.
 from .colorize import Ansi, Colors, Styles, colorize, log_stage
@@ -22,7 +28,7 @@
 from .provider import Provider
 from .utils import cd, merge_kwargs, set_env, unset_env
 
-__version__ = "0.1.0"
+__version__ = "0.1.0.post0"
 __all__ = [
     # Core imports from ci_exec.colorize module.
     "Ansi", "Colors", "Styles", "colorize", "log_stage",

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -4,3 +4,4 @@ git+https://github.com/sphinx-doc/[email protected]
 # sphinx>=2.0.0
 sphinx_rtd_theme
 pytest
+sphinx-issues
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
@@ -0,0 +1,14 @@
+Changelog
+========================================================================================
+
+v0.1.0.post0
+----------------------------------------------------------------------------------------
+
+- Fix support for early 3.5.x by conditionally importing ``NoReturn`` and
+  ``TYPE_CHECKING`` (:pr:`12`).
+
+v0.1.0
+----------------------------------------------------------------------------------------
+
+Initial release.  Broken for python 3.5.x where ``typing`` module does not house
+``NoReturn`` and ``TYPE_CHECKING``.  Definitely broken on 3.5.2 and earlier.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -51,7 +51,8 @@
     "sphinx.ext.autosummary",
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
-    "sphinx.ext.viewcode"
+    "sphinx.ext.viewcode",
+    "sphinx_issues"
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -85,6 +86,9 @@
 napoleon_google_docstring = False
 napoleon_numpy_docstring = True
 
+# See: https://github.com/sloria/sphinx-issues
+issues_github_path = "svenevs/ci_exec"
+
 
 def get_all_top_level():
     """Return list of fully qualified strings for ci_exec top level names."""

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -84,3 +84,4 @@ Quick reference:
    api/root
    demos
    important_usage_notes
+   changelog