From c5c28b4c4b3d97c55d6637f83bd9cd65427d8185 Mon Sep 17 00:00:00 2001
From: SeaswimmerTheFsh <seaswimmerthefsh@gmail.com>
Date: Thu, 21 Dec 2023 14:08:09 -0500
Subject: [PATCH] docs: updated documentation

---
 docs/getting-started/installation.md | 10 +++++-----
 docs/getting-started/versioning.md   |  7 +++++++
 mkdocs.yml                           |  6 ++++--
 pyproject.toml                       |  2 +-
 pyzipline/zipline.py                 |  1 +
 5 files changed, 18 insertions(+), 8 deletions(-)
 create mode 100644 docs/getting-started/versioning.md

diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md
index 6b41124..861b3e5 100644
--- a/docs/getting-started/installation.md
+++ b/docs/getting-started/installation.md
@@ -10,7 +10,7 @@ There has not been an official release of PyZipline on PyPi yet, meaning these i
     attrs: {class: annotate}
 **Please make sure to install the matching version of PyZipline for your Zipline version!**  
 This documentation assumes you are using Zipline `3.7.7`.  
-If you are not, please change all occurrances of `3.7.7` to your Zipline version.  
+If you are not, please see [Versioning](./versioning.md) for a list of supported versions.  
 If you're on [Zipline's `trunk` version](https://github.com/diced/zipline/tree/trunk), use `*` to get the latest versions of PyZipline. (1)
 ///
 
@@ -24,13 +24,13 @@ The command to use differs slightly depending on what OS/Distro you use.
 On Windows:
 
 ``` prolog title="Command Prompt"
-py -m pip install pyzipline=3.7.7
+py -m pip install pyzipline=0.1.0
 ```
 
 On macOS and Linux:
 
 ``` prolog title="Bash"
-python3 -m pip install pyzipline=3.7.7
+python3 -m pip install pyzipline=0.1.0
 ```
 
 ## Poetry
@@ -39,12 +39,12 @@ You can also use [Poetry](https://python-poetry.org/) to store your dependencies
 Use the following command to install PyZipline:
 
 ``` prolog title="Command Prompt / Shell"
-poetry add pyzipline=3.7.7
+poetry add pyzipline=0.1.0
 ```
 
 Or, you can add PyZipline to your `pyproject.toml` file manually:
 
 ``` toml title="pyproject.toml"
 [tool.poetry.dependencies]
-pyzipline = "3.7.7"
+pyzipline = "0.1.0"
 ```
diff --git a/docs/getting-started/versioning.md b/docs/getting-started/versioning.md
new file mode 100644
index 0000000..4dded17
--- /dev/null
+++ b/docs/getting-started/versioning.md
@@ -0,0 +1,7 @@
+# Versioning
+
+Below is a table containing versions of Zipline, alongside their respective PyZipline versions.
+
+| PyZipline Versions | Zipline Versions |         Supported        |       Security Fixes      |
+| :----------------: | :--------------: | :----------------------: | :-----------------------: |
+| `0.1.0`            | `3.7.7`          | :white_check_mark:       | :white_check_mark:        |
diff --git a/mkdocs.yml b/mkdocs.yml
index b7175a3..6af6ebc 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -13,6 +13,7 @@ nav:
   - Getting Started:
     - Installation: getting-started/installation.md
     - Usage: getting-started/usage.md
+    - Versioning: getting-started/versioning.md
   - Reference:
     - ZiplineApi: ref/zipline.md
     - Utilities: ref/utils.md
@@ -44,6 +45,7 @@ markdown_extensions:
   - abbr
   - attr_list
   - md_in_html
+  - tables
   - pymdownx.blocks.details
   - pymdownx.blocks.admonition
   - pymdownx.saneheaders
@@ -57,8 +59,8 @@ markdown_extensions:
       line_spans: __span
       pygments_lang_class: true
   - pymdownx.emoji:
-      emoji_index: !!python/name:pymdownx.emoji.twemoji
-      emoji_generator: !!python/name:pymdownx.emoji.to_svg
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
 
 theme:
   name: material
diff --git a/pyproject.toml b/pyproject.toml
index 07b88fc..c0339bd 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyzipline"
-version = "3.7.7"
+version = "0.1.0"
 description = "Python API Wrapper for the Zipline API"
 authors = ["SeaswimmerTheFsh <seaswimmerthefsh@gmail.com>"]
 license = "GNU GPLv3"
diff --git a/pyzipline/zipline.py b/pyzipline/zipline.py
index 0db65eb..7ba38b3 100644
--- a/pyzipline/zipline.py
+++ b/pyzipline/zipline.py
@@ -112,6 +112,7 @@ class ZiplineApi:
         ///
 
         Raises:
+            Forbidden: The user is not authenticated
             PyZiplineError: Raised if the API changes, causing a breaking change in this method
 
         Returns: