Revert "Revert "Utilise Pipenv for reproducible builds""

Author: MisterStump

Pipfile

@@ -0,0 +1,13 @@
+[[source]]
+url = "https://pypi.python.org/simple"
+verify_ssl = true
+name = "Tabletop Simulator API"
+
+[packages]
+mkdocs-material = "~= 3.0.4"
+mkdocs = "~=1.0.4"
+pygments = "~=2.2.0"
+pymdown-extensions = "~=5.0"
+
+[requires]
+python_version = "3.6"

Pipfile.lock

@@ -1,15 +1,47 @@
 # Tabletop Simulator API
 
-This is the source of the api documentation in Tabletop Simulator. It uses a modified version of [Material-Design](https://github.com/squidfunk/mkdocs-material) for MKDocs.
+This is the source of the api documentation in Tabletop Simulator. It uses a modified version of [Material-Design](https://github.com/squidfunk/mkdocs-material) for MkDocs.
 
 ## How it Works
 
 The `.md` files in the `/docs` folder are written in Markdown, which is an easy-to-use markup language to add formatting to text. Additionally, some custom CSS is used, as well as a handful of custom images. When making changes, it is possible to live-preview them as you go if you have set up the local files for mkdocs + material design.
 
 Alternatively, you can make modifications to individual pages then submit them for review. The developers will always be the ones to build and publish the site anyway, all you will do is modify the contents of this Git.
 
-### Installing
+## Contributing
 
-If you choose to install MKDocs so you can live-preview your changes, you may do so [by following these instructions](https://squidfunk.github.io/mkdocs-material/getting-started/).
+The API website is built using [MkDocs](https://www.mkdocs.org/) and several related extensions.
 
-Otherwise, you will not need to install anything to edit the text files.
+Pull requests are welcome, however in order to preview your changes, you must follow the instructions below:
+
+### Prerequisites
+
+You will need to ensure Python `3.6` is installed on your system.
+
+If your system doesn't have it installed, you can either [download directly](https://www.python.org/downloads/release/python-366/) or install from a Python version manager such as [pyenv](https://github.com/pyenv/pyenv).
+
+We utilise Pipenv and a `Pipfile` to ensure builds are consistent. If you don't already have Pipenv installed, please follow the official [pipenv install instructions](https://pipenv.readthedocs.io/en/latest/install/#installing-pipenv) for you platform.
+
+### Installing Dependencies
+
+Once've you installed the prerequisites, you must initialize your environment. From command line, this is done with:
+
+```
+pipenv install
+```
+
+You can then "activate" this environment with:
+
+```
+pipenv shell
+```
+
+### Previewing
+
+Once your Pipenv environment is activated, you can simply execute:
+
+```
+mkdocs serve
+```
+
+Then open your browser and navigate to `http://localhost:8000` in order to view your changes.

README.md

@@ -26,10 +26,8 @@
   {% set class = "md-nav__item md-nav__item--active" %}
 {% endif %}
 
-
 <!-- Main navigation item with nested items -->
 {% if nav_item.children %}
-  <hr style=" border: 0; height: 0; border-top: 1px solid rgba(0, 0, 0, 0.1); border-bottom: 1px solid rgba(255, 255, 255, 0.3);">
   <li class="{{ class }} md-nav__item--nested">
 
     <!-- Active checkbox expands items contained within nested section -->
@@ -70,7 +68,7 @@
 
     <!-- Active checkbox expands items contained within nested section -->
     <input class="md-toggle md-nav__toggle" data-md-toggle="toc"
-        type="checkbox" id="toc" />
+        type="checkbox" id="__toc" />
 
     <!-- Hack: see partials/toc.html for more information -->
     {% if toc_ | first is defined and "\x3ch1 id=" in page.content %}
@@ -79,11 +77,11 @@
 
     <!-- Render table of contents, if not empty -->
     {% if toc_ | first is defined %}
-      <label class="md-nav__link md-nav__link--active" for="toc">
+      <label class="md-nav__link md-nav__link--active" for="__toc">
         {{ nav_item.title }}
       </label>
     {% endif %}
-    <a href="{{ nav_item.url }}" title="{{ nav_item.title }}"
+    <a href="{{ nav_item.url | url }}" title="{{ nav_item.title }}"
         class="md-nav__link md-nav__link--active">
       {{ nav_item.title }}
     </a>
@@ -97,7 +95,7 @@
 <!-- Main navigation item -->
 {% else %}
   <li class="{{ class }}">
-    <a href="{{ nav_item.url }}" title="{{ nav_item.title }}"
+    <a href="{{ nav_item.url | url }}" title="{{ nav_item.title }}"
         class="md-nav__link">
       {{ nav_item.title }}
     </a>