feat(docs): adding more documentation and customization
Some checks failed
Pylint / Pylint (3.12) (push) Failing after 37s
Some checks failed
Pylint / Pylint (3.12) (push) Failing after 37s
This commit is contained in:
parent
d27bdda769
commit
3fbae612ff
6 changed files with 140 additions and 22 deletions
31
docs/getting-started/installation.md
Normal file
31
docs/getting-started/installation.md
Normal file
|
@ -0,0 +1,31 @@
|
|||
# Installation
|
||||
|
||||
/// 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.
|
||||
///
|
||||
|
||||
## pip
|
||||
|
||||
You can use pip to install PyZipline.
|
||||
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
|
||||
```
|
||||
|
||||
On macOS and Linux:
|
||||
|
||||
``` prolog title="Bash"
|
||||
python3 -m pip install pyzipline
|
||||
```
|
||||
|
||||
## 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:
|
||||
|
||||
``` prolog title="Command Prompt / Shell"
|
||||
poetry add pyzipline
|
||||
```
|
1
docs/getting-started/usage.md
Normal file
1
docs/getting-started/usage.md
Normal file
|
@ -0,0 +1 @@
|
|||
# Usage
|
|
@ -1,20 +1,11 @@
|
|||
# Welcome to PyZipline
|
||||
|
||||
/// 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 :doc:`usage` section for further information, including
|
||||
how to :ref:`install` the project.
|
||||
|
||||
## Commands
|
||||
|
||||
* `mkdocs new [dir-name]` - Create a new project.
|
||||
* `mkdocs serve` - Start the live-reloading docs server.
|
||||
* `mkdocs build` - Build the documentation site.
|
||||
* `mkdocs -h` - Print help message and exit.
|
||||
|
||||
## Project layout
|
||||
|
||||
mkdocs.yml # The configuration file.
|
||||
docs/
|
||||
index.md # The documentation homepage.
|
||||
... # Other markdown pages, images and other files.
|
||||
Check out the [usage](getting-started/usage.md) section for further information, including
|
||||
how to [install](getting-started/installation.md) the project.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue