Add sphinx docs

jazzband · Mar 19, 2020 · 86099aa · 86099aa
1 parent 9687e27
commit 86099aa
Show file tree

Hide file tree

Showing 17 changed files with 1,211 additions and 540 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -36,30 +36,36 @@ common: &common
         key: v5-cache-{{ .Environment.CIRCLE_JOB }}-{{ checksum "setup.py" }}-{{ checksum "tox.ini" }}
 
 jobs:
+  docs:
+    <<: *common
+    docker:
+      - image: circleci/python:3.7
+        environment:
+          TOXENV: docs
   django20:
     <<: *common
     docker:
       - image: circleci/python:3.6
         environment:
-          TOXENV: 'py36-django20-drf{38,39}'
+          TOXENV: 'py36-django20-drf{38,39}-tests'
   django21:
     <<: *common
     docker:
       - image: circleci/python:3.7
         environment:
-          TOXENV: 'py37-django21-drf{39,310}'
+          TOXENV: 'py37-django21-drf{39,310}-tests'
   django22:
     <<: *common
     docker:
       - image: circleci/python:3.7
         environment:
-          TOXENV: 'py37-django22-drf{39,310}'
+          TOXENV: 'py37-django22-drf{39,310}-tests'
   django30:
     <<: *common
     docker:
       - image: circleci/python:3.8
         environment:
-          TOXENV: 'py38-django30-drf310'
+          TOXENV: 'py38-django30-drf310-tests'
   djangomaster:
     working_directory: ~/repo
     steps:
@@ -96,7 +102,7 @@ jobs:
     docker:
       - image: circleci/python:3.8
         environment:
-          TOXENV: 'py38-djangomaster-drf310'
+          TOXENV: 'py38-djangomaster-drf310-tests'
   lint:
     <<: *common
     docker:
@@ -108,6 +114,7 @@ workflows:
   version: 2
   test:
     jobs:
+      - docs
       - django20
       - django21
       - django22

diff --git a/.gitignore b/.gitignore
@@ -18,3 +18,7 @@ coverage.*
 !.gitignore
 !.travis.yml
 !.isort.cfg
+
+# Sphinx
+docs/_build
+docs/modules.rst
diff --git a/Makefile b/Makefile
@@ -37,7 +37,16 @@ test-all:
 	tox
 
 build-docs:
-	sphinx-apidoc -o docs/ . setup.py "*conftest*"
+	sphinx-apidoc -o docs/ . \
+		setup.py \
+		*confest* \
+		tests/* \
+		rest_framework_simplejwt/token_blacklist/* \
+		rest_framework_simplejwt/backends.py \
+		rest_framework_simplejwt/compat.py \
+		rest_framework_simplejwt/exceptions.py \
+		rest_framework_simplejwt/settings.py \
+		rest_framework_simplejwt/state.py
 	$(MAKE) -C docs clean
 	$(MAKE) -C docs html
 	$(MAKE) -C docs doctest