From f7db8bb8c6d1db081859805de0c9d571276b5dd7 Mon Sep 17 00:00:00 2001
From: Joe Gordon <jogo@pinterest.com>
Date: Fri, 22 Jul 2022 10:05:48 -0700
Subject: Fix docs

* autodoc wasn't generating docs correnctly
* add pytest so sphinx can render test docs, excluding them from docs
  for now though (so generated, but no link to them)
* Update version info in docs/conf.py
* Fix a few sphinx warnings
* Add in changelog into docs and switch to toctree depth of 1, as the
  changelog has a lat of H2 headers.
* Add docs to CI
---
 .github/workflows/ci.yml | 4 ++++
 1 file changed, 4 insertions(+)

(limited to '.github')

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 330d2db..08c3fa1 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -35,6 +35,10 @@ jobs:
       if: matrix.python-version == '3.10'
       run: |
         tox -e lint,mypy
+    - name: Docs
+      if: matrix.python-version == '3.10'
+      run: |
+        tox -e docs
     - name: Disable IPv6 localhost
       run: |
         sudo sed -i '/::1/d' /etc/hosts
-- 
cgit v1.2.1