updating docs more
Some checks failed
Pylint / Pylint (3.12) (push) Failing after 35s

This commit is contained in:
SeaswimmerTheFsh 2023-12-20 14:28:15 -05:00
parent 58bb23c795
commit 6cc8a2dd0b
Signed by: cswimr
GPG key ID: 1EBC234EEDA901AE
7 changed files with 47 additions and 27 deletions

View file

@ -1,13 +0,0 @@
:root {
--external-link-icon: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 512 512'%3E%3Clink xmlns='' type='text/css' rel='stylesheet' id='dark-mode-custom-link'/%3E%3Clink xmlns='' type='text/css' rel='stylesheet' id='dark-mode-general-link'/%3E%3Cstyle xmlns='' lang='en' type='text/css' id='dark-mode-custom-style'/%3E%3Cstyle xmlns='' lang='en' type='text/css' id='dark-mode-native-style'/%3E%3Cpath d='M432 320h-32a16 16 0 0 0-16 16v112H64V128h144a16 16 0 0 0 16-16V80a16 16 0 0 0-16-16H48a48 48 0 0 0-48 48v352a48 48 0 0 0 48 48h352a48 48 0 0 0 48-48V336a16 16 0 0 0-16-16zM488 0H360c-21.37 0-32.05 25.91-17 41l35.73 35.73L135 320.37a24 24 0 0 0 0 34L157.67 377a24 24 0 0 0 34 0l243.61-243.68L471 169c15 15 41 4.5 41-17V24a24 24 0 0 0-24-24z'/%3E%3C/svg%3E");
}
a[href^="http" ]:not(.md-button, [data-sub-html], .md-footer-social__link, .md-source, .md-search-result__link, .md-logo, .md-version__link, [href*="config.discordsrv.com"], [href*="squidfunk.github.io"], [href*="Documentation/edit"]):after {
background: transparent var(--external-link-icon) 0 0 no-repeat;
content: "";
display: inline-block;
height: 12px;
margin-left: 3px;
width: 12px;
filter: invert(1);
}

View file

@ -1,10 +1,21 @@
# Installation
/// admonition | This project is in active development.
/// admonition | This project is in active development
type: danger
There has not been an official release of PyZipline on PyPi yet, meaning these installation docs don't work.
///
/// admonition | Using the correct version
type: warning
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're on [Zipline's `trunk` version](https://github.com/diced/zipline/tree/trunk), use `*` to get the latest versions of PyZipline. (1)
///
1. I will not always update to `trunk` versions, I may occassionally do so, but for the most part, expect breaking changes to recieve fixes when a new Zipline version is released.
## pip
You can use pip to install PyZipline.
@ -13,19 +24,26 @@ The command to use differs slightly depending on what OS/Distro you use.
On Windows:
``` prolog title="Command Prompt"
py -m pip install -U pyzipline
py -m pip install -U pyzipline=3.7.7
```
On macOS and Linux:
``` prolog title="Bash"
python3 -m pip install pyzipline
python3 -m pip install -U pyzipline=3.7.7
```
## Poetry
You can also use [Poetry](https://python-poetry.org/) to store your dependencies. Add PyZipline to your `pyproject.toml` file manually, or use this command:
You can also use [Poetry](https://python-poetry.org/) to store your dependencies. Add PyZipline to your `pyproject.toml` file manually.
``` toml title="pyproject.toml"
[tool.poetry.dependencies]
pyzipline = "3.7.7"
```
Or, you can use this command:
``` prolog title="Command Prompt / Shell"
poetry add pyzipline
poetry add pyzipline=3.7.7
```

View file

@ -1,11 +1,11 @@
# Welcome to PyZipline
/// admonition | This project is in active development.
/// admonition | This project is in active development
type: warning
These docs are not complete yet, and there is a lot still to do.
///
**PyZipline** is a Python API Wrapper for the [Zipline](https://zipline.diced.sh/) API.
Check out the [usage](getting-started/usage.md) section for further information, including
how to [install](getting-started/installation.md) the project.
Check out the [usage](getting-started/usage.md) section for further information.
Installation instructions can be found [here](getting-started/installation.md).