Merge pull request #37 from pganssle/prepare_build

Prepare for distribution builds

Author: pganssle

README.md

@@ -9,16 +9,14 @@
 Grid-strategy is a python package that enables the user
 organize _matplotlib_ plots using different **grid strategies**.
 
-Abstract
-----
+## Abstract
 
 This package would add a mechanism for creating a grid of
 subplots based on the number of axes to be plotted and
 a strategy for how they should be arranged, with some
 sensible strategy as the default.
 
-Detailed Description
-----
+## Detailed Description
 
 It is often the case that you have some number of
 plots to display (and this number may be unknown

azure-pipelines.yml

@@ -16,6 +16,12 @@ strategy:
     Black:
       python.version: '3.7'
       TOXENV: black-check
+    Docs:
+      python.version: '3.6'
+      TOXENV: docs
+    Build:
+      python.version: '3.6'
+      TOXENV: build
 
 variables:
   TOXENV: py

docs/conf.py

@@ -91,7 +91,7 @@
 # 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"]
+html_static_path = []
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.

docs/requirements-docs.txt

@@ -0,0 +1 @@
+Sphinx>=1.7.3,!=1.8.0

setup.cfg

@@ -1,10 +1,12 @@
 [metadata]
 name = grid-strategy
 version = 0.0.1
+description = A package for organizing matplotlib plots.
 author = Grid Strategy Authors
 author-email = paul@ganssle.io
-summary = A package for organizing matplotlib plots.
-description = file: README.md
+url = https://github.com/matplotlib/grid-strategy
+long_description = file: README.md
+long_description_content_type = text/markdown
 license = Apache License 2.0
 license_file = LICENSE
 classifiers =

src/grid_strategy/strategies.py

@@ -27,9 +27,11 @@ def get_grid_arrangement(cls, n):
             grid would be represented as ``(3, 3)``, because there are 2 rows
             of length 3.
 
-        Example:
-        --------
+
+        **Example:**
+
         .. code::
+
             >>> GridStrategy.get_grid(7)
             (2, 3, 2)
             >>> GridStrategy.get_grid(6)

tox.ini

@@ -39,3 +39,21 @@ description = test if black works
 deps =
     pytest-black
 commands = pytest --black
+
+[testenv:docs]
+description = invoke sphinx-build to build the HTML docs, check that URIs are valid
+basepython = python3.6
+deps = -r docs/requirements-docs.txt
+commands = sphinx-build -d "{toxworkdir}/docs_doctree" docs \
+                           "{toxworkdir}/docs_out" {posargs:-W --color}
+           sphinx-build -d "{toxworkdir}/docs_doctree" docs \
+                           "{toxworkdir}/docs_out" {posargs:-W --color -blinkcheck}
+
+[testenv:build]
+description = Build the documentation
+deps = twine
+       pep517
+       readme_renderer[md] >= 24.0
+commands = python -m pep517.build --source --binary {toxinidir} \
+                                  --out-dir {toxinidir}/dists
+           twine check {toxinidir}/dists/*