docs: updated documentation

This commit is contained in:
Seaswimmer 2023-12-21 14:08:09 -05:00
parent adfe6de1cf
commit c5c28b4c4b
Signed by: cswimr
GPG key ID: 1EBC234EEDA901AE
5 changed files with 18 additions and 8 deletions

View file

@ -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"
```

View file

@ -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: |

View file

@ -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

View file

@ -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"

View file

@ -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: