Docs version control and new theme (#176)

- Version controlled docs
   - Every time something is committed to `main`, it will update the `develop` docs.
   - Every time a version is released, it will push a new version number to the docs.
- Use our new ReactPy docs theme, which is an even better imitation of ReactJS docs 
- Fix `GITHUB_ACTIONS` env type conversion

Author: Archmonger

.github/workflows/publish-develop-docs.yml

@@ -0,0 +1,18 @@
+name: Publish Develop Docs
+on:
+    push:
+        branches:
+            - main
+jobs:
+    deploy:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v3
+              with:
+                  fetch-depth: 0
+            - uses: actions/setup-python@v4
+              with:
+                  python-version: 3.x
+            - run: pip install -r requirements/build-docs.txt
+            - name: Publish Develop Docs
+              run: mike deploy --push develop

.github/workflows/publish-docs.yml

@@ -0,0 +1,19 @@
+name: Publish Release Docs
+
+on:
+    release:
+        types: [published]
+
+jobs:
+    deploy:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v3
+              with:
+                  fetch-depth: 0
+            - uses: actions/setup-python@v4
+              with:
+                  python-version: 3.x
+            - run: pip install -r requirements/build-docs.txt
+            - name: Publish ${{ github.event.release.name }} Docs
+              run: mike deploy --push --update-aliases ${{ github.event.release.name }} latest

.github/workflows/publish-release-docs.yml

@@ -34,6 +34,10 @@ Using the following categories, list your changes in this order:
 
 ## [Unreleased]
 
+### Added
+
+-   [ReactPy-Django docs](https://reactive-python.github.io/reactpy-django/) are now version controlled via [mike](https://github.com/jimporter/mike)!
+
 ### Changed
 
 -   Bumped the minimum ReactPy version to `1.0.2`.

CHANGELOG.md

@@ -23,6 +23,8 @@
 <!--badge-end-->
 <!--intro-start-->
 
+[ReactPy-Django](https://github.com/reactive-python/reactpy-django) is used to add used to add [ReactPy](https://reactpy.dev/) support to an existing **Django project**.
+
 [ReactPy](https://reactpy.dev/) is a library for building user interfaces in Python without Javascript. ReactPy interfaces are made from components that look and behave similar to those found in [ReactJS](https://reactjs.org/). Designed with simplicity in mind, ReactPy can be used by those without web development experience while also being powerful enough to grow with your ambitions.
 
 <table align="center">
@@ -77,11 +79,12 @@ def hello_world(recipient: str):
 
 <!--html-header-start-->
 
-In your **Django app**'s HTML template, you can now embed your ReactPy component using the `component` template tag. Within this tag, you will need to type in your dotted path to the component function as the first argument.
-
-Additionally, you can pass in `args` and `kwargs` into your component function. For example, after reading the code below, pay attention to how the function definition for `hello_world` (_in the previous example_) accepts a `recipient` argument.
+In your **Django app**'s HTML template, you can now embed your ReactPy component using the `component` template tag. Within this tag, you will need to type in the dotted path to the component.
 
 <!--html-header-end-->
+
+Additionally, you can pass in `args` and `kwargs` into your component function. After reading the code below, pay attention to how the function definition for `hello_world` (_from the previous example_) accepts a `recipient` argument.
+
 <!--html-code-start-->
 
 ```jinja

README.md

@@ -11,3 +11,10 @@
 </div>
 {% endif %}
 {% endblock %}
+
+{% block outdated %}
+You're not viewing the latest version.
+<a href="{{ '../' ~ base_url }}">
+    <strong>Click here to go to latest.</strong>
+</a>
+{% endblock %}

docs/overrides/main.html

@@ -3,8 +3,12 @@ hide:
     - toc
 ---
 
-!!! summary "Attribution"
+<p class="intro" markdown>
 
-        {% include-markdown "../../../CHANGELOG.md" start="<!--attr-start-->" end="<!--attr-end-->" %}
+{% include-markdown "../../../CHANGELOG.md" start="<!--attr-start-->" end="<!--attr-end-->" %}
+
+</p>
+
+---
 
 {% include-markdown "../../../CHANGELOG.md" start="<!--changelog-start-->" %}

docs/src/changelog/index.md

@@ -1,12 +1,18 @@
 ## Overview
 
-!!! summary "Overview"
+<p class="intro" markdown>
 
     You will need to set up a Python environment to develop ReactPy-Django.
 
-??? tip "Looking to contribute features that are not Django specific?"
+</p>
 
-    Everything within the `reactpy-django` repository must be specific to Django integration. Check out the [ReactPy Core documentation](https://reactpy.dev/docs/about/contributor-guide.html) to contribute general features such as: components, hooks, events, and more.
+!!! note
+
+    Looking to contribute features that are not Django specific?
+
+    Everything within the `reactpy-django` repository must be specific to Django integration. Check out the [ReactPy Core documentation](https://reactpy.dev/docs/about/contributor-guide.html) to contribute general features such as components, hooks, and events.
+
+---
 
 ## Modifying Code
 

docs/src/contribute/code.md

@@ -1,8 +1,12 @@
 ## Overview
 
-!!! summary "Overview"
+<p class="intro" markdown>
 
-    You will need to set up a Python environment to preview docs changes.
+You will need to set up a Python environment to create, test, and preview docs changes.
+
+</p>
+
+---
 
 ## Modifying Docs
 

docs/src/contribute/docs.md

@@ -1,8 +1,12 @@
 ## Overview
 
-!!! summary "Overview"
+<p class="intro" markdown>
 
-    You will need to set up a Python environment to run out test suite.
+You will need to set up a Python environment to run the ReactPy-Django test suite.
+
+</p>
+
+---
 
 ## Running Tests
 
@@ -29,17 +33,26 @@ By running the command below you can run the full test suite:
 nox -s test
 ```
 
-Or, if you want to run the tests in the foreground:
+Or, if you want to run the tests in the background:
 
 ```bash linenums="0"
-nox -s test -- --headed
+nox -s test -- --headless
 ```
 
-## Only Django Tests
+## Django Tests
 
-Alternatively, if you want to only run Django related tests, you can use the following command:
+If you want to only run our Django tests in your current environment, you can use the following command:
 
 ```bash linenums="0"
 cd tests
 python manage.py test
 ```
+
+## Django Test Webserver
+
+If you want to manually run the Django test application, you can use the following command:
+
+```bash linenums="0"
+cd tests
+python manage.py runserver
+```