docs: update stuff or something
This commit is contained in:
parent
bd4a90a6be
commit
6a250a24fb
11 changed files with 23 additions and 12 deletions
1
.gitignore
vendored
1
.gitignore
vendored
|
@ -1,2 +1,3 @@
|
|||
__pycache__
|
||||
.cache
|
||||
.zipline
|
||||
|
|
|
@ -1,3 +1,4 @@
|
|||
# PyZipline
|
||||
|
||||
PyZipline is a Python API Wrapper for use with [Zipline](https://zipline.diced.sh).
|
||||
Documentation can be found [here](https://pyzipline.readthedocs.io/en/latest).
|
||||
|
|
Before Width: | Height: | Size: 496 KiB After Width: | Height: | Size: 496 KiB |
Before Width: | Height: | Size: 34 KiB After Width: | Height: | Size: 34 KiB |
|
@ -1,3 +0,0 @@
|
|||
# Exceptions
|
||||
|
||||
::: pyzipline.errors
|
3
docs/ref/exceptions.md
Normal file
3
docs/ref/exceptions.md
Normal file
|
@ -0,0 +1,3 @@
|
|||
# Exceptions
|
||||
|
||||
::: pyzipline.exceptions
|
|
@ -1,3 +1,9 @@
|
|||
# Rest Adapter
|
||||
|
||||
/// admonition | Internal Functions
|
||||
type: warning
|
||||
These functions are meant for use in other parts of the module. You *probably* shouldn't be calling these manually.
|
||||
If there's a feature missing from the main [ZiplineApi](zipline.md) class, you should open an [issue](https://coastalcommits.com/SeaswimmerTheFsh/PyZipline/issues) (or a [pull request](https://coastalcommits.com/SeaswimmerTheFsh/PyZipline/pulls)).
|
||||
///
|
||||
|
||||
::: pyzipline.rest_adapter.RestAdapter
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# API Reference
|
||||
# ZiplineApi
|
||||
|
||||
::: pyzipline.zipline.ZiplineApi
|
||||
|
|
15
mkdocs.yml
15
mkdocs.yml
|
@ -14,18 +14,19 @@ nav:
|
|||
- Installation: getting-started/installation.md
|
||||
- Usage: getting-started/usage.md
|
||||
- Reference:
|
||||
- Zipline: ref/zipline.md
|
||||
- ZiplineApi: ref/zipline.md
|
||||
- Utilities: ref/utils.md
|
||||
- Exceptions: ref/exceptions.md
|
||||
- Models: ref/models.md
|
||||
- Rest Adapter: ref/rest_adapter.md
|
||||
|
||||
plugins:
|
||||
- git-revision-date-localized:
|
||||
enable_creation_date: true
|
||||
- git-authors
|
||||
- search
|
||||
- social
|
||||
- git-revision-date-localized:
|
||||
enable_creation_date: true
|
||||
type: timeago
|
||||
- mkdocstrings:
|
||||
default_handler: python
|
||||
handlers:
|
||||
|
@ -63,11 +64,13 @@ theme:
|
|||
features:
|
||||
- content.code.annotate
|
||||
- content.code.copy
|
||||
- content.tooltips
|
||||
- navigation.instant
|
||||
- navigation.tabs
|
||||
- search.suggest
|
||||
- search.highlight
|
||||
- search.share
|
||||
logo: logo.png
|
||||
favicon: logo.png
|
||||
logo: img/logo.png
|
||||
favicon: img/logo.png
|
||||
|
||||
watch:
|
||||
- ./pyzipline
|
||||
|
|
|
@ -5,7 +5,7 @@ from json import JSONDecodeError
|
|||
import requests
|
||||
from urllib3 import disable_warnings
|
||||
|
||||
from pyzipline.errors import HTTPFailure, PyZiplineError
|
||||
from pyzipline.exceptions import HTTPFailure, PyZiplineError
|
||||
from pyzipline.models import Result
|
||||
|
||||
class RestAdapter:
|
||||
|
|
Loading…
Reference in a new issue