fix documentation syntax highlight (#326)

* Add `scripts/docs` and `scripts/build`

Co-authored-by: Amin Alaee <mohammadamin.alaee@gmail.com>

.github/workflows/publish.yml

@@ -16,7 +16,11 @@ jobs:
       - uses: "actions/setup-python@v1"
         with:
           python-version: 3.7
-      - name: "Publish"
+      - name: "Install dependencies"
+        run: "scripts/install"
+      - name: "Build package & docs"
+        run: "scripts/build"
+      - name: "Publish to PyPI & deploy docs"
         run: "scripts/publish"
         env:
           TWINE_USERNAME: __token__

mkdocs.yml

@@ -15,5 +15,7 @@ nav:
     - Tests & Migrations: 'tests_and_migrations.md'
 
 markdown_extensions:
+  - mkautodoc
   - admonition
-  - codehilite
+  - pymdownx.highlight
+  - pymdownx.superfences

requirements.txt

@@ -23,3 +23,12 @@ pytest
 pytest-cov
 starlette
 requests
+
+# Documentation
+mkdocs
+mkdocs-material
+mkautodoc
+
+# Packaging
+twine
+wheel

scripts/build

@@ -0,0 +1,13 @@
+#!/bin/sh -e
+
+if [ -d 'venv' ] ; then
+    PREFIX="venv/bin/"
+else
+    PREFIX=""
+fi
+
+set -x
+
+${PREFIX}python setup.py sdist bdist_wheel
+${PREFIX}twine check dist/*
+${PREFIX}mkdocs build

scripts/publish

@@ -1,7 +1,6 @@
 #!/bin/sh -e
 
 VERSION_FILE="databases/__init__.py"
-PYTHONPATH=.
 
 if [ -d 'venv' ] ; then
     PREFIX="venv/bin/"
@@ -23,7 +22,5 @@ fi
 
 set -x
 
-${PREFIX}pip install twine wheel mkdocs mkdocs-material mkautodoc
-${PREFIX}python setup.py sdist bdist_wheel
 ${PREFIX}twine upload dist/*
 ${PREFIX}mkdocs gh-deploy --force