Fix readthedocs deploys (#525)

* remove unneeded graphiql dep

* use latest stable mkdocs version 1.5.3

* config for readthedocs build

* link missing pros and cons page

* update changelog

* use mkdocs 1.0.4

* update contributing.md

* add missing dep to requirements.txt

.readthedocs.yaml

@@ -0,0 +1,19 @@
+# Read the Docs configuration file for MkDocs projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.9"
+
+mkdocs:
+  configuration: mkdocs.yml
+
+# Optionally declare the Python requirements required to build your docs
+python:
+  install:
+  - requirements: docs/requirements.txt

CONTRIBUTING.md

@@ -82,6 +82,11 @@ New versions MUST be compliant with [semver](http://semver.org/).
 
 The [docs](https://join-monster.readthedocs.io/en/latest/) should be updated on pushes to `master` (via webhook to Read the Docs). [Build history](https://readthedocs.org/projects/join-monster/builds/).
 
+For local development you need mkdocs:
+Run `pip3 install -r docs/requirements.txt`
+
+NOTE: This configuration was tested with python 3.9 which is what readthedocs is running.
+
 ## License
 
 By contributing to Join Monster, you agree that your contributions will be licensed under the LICENSE file in the project root directory.

docs/CHANGELOG.md

@@ -1,5 +1,6 @@
 ### vNEXT 
 #### Fixed
+- [#525](https://github.com/join-monster/join-monster/pull/525): Fix readthedocs deploys.
 - [#526](https://github.com/join-monster/join-monster/pull/526): Warns when alias length is exceeded for what postgres allows.
 - [#523](https://github.com/join-monster/join-monster/pull/523): Make demo runnable again.
 - [#522](https://github.com/join-monster/join-monster/pull/522): Version bumps for critical dependencies.

docs/requirements.txt

@@ -0,0 +1,9 @@
+mkdocs==1.0.4
+click==3.3
+Jinja2==2.7.1
+livereload==2.5.1
+Markdown==3.0.0
+PyYAML==5.1
+tornado==5.0
+mdx_gh_links>=0.2
+markupsafe==2.0.1

mkdocs.yml

@@ -13,6 +13,7 @@ pages:
   - Introduction: index.md
   - "The Problem We Solve": problem.md
   - "How It Works": how-it-works.md
+  - "Pros & Cons": pros-cons.md
   - "Basic Usage":
     - "1. Declare Data Model": data-model.md
     - "2. Map Objects to Tables": map-to-table.md