docs: update stuff or something

This commit is contained in:
Seaswimmer 2023-12-20 20:48:18 -05:00
parent bd4a90a6be
commit 6a250a24fb
Signed by: cswimr
GPG key ID: 1EBC234EEDA901AE
11 changed files with 23 additions and 12 deletions

1
.gitignore vendored
View file

@ -1,2 +1,3 @@
__pycache__ __pycache__
.cache .cache
.zipline

View file

@ -1,3 +1,4 @@
# PyZipline # PyZipline
PyZipline is a Python API Wrapper for use with [Zipline](https://zipline.diced.sh). 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).

View file

Before

Width:  |  Height:  |  Size: 496 KiB

After

Width:  |  Height:  |  Size: 496 KiB

View file

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 34 KiB

View file

@ -1,3 +0,0 @@
# Exceptions
::: pyzipline.errors

3
docs/ref/exceptions.md Normal file
View file

@ -0,0 +1,3 @@
# Exceptions
::: pyzipline.exceptions

View file

@ -1,3 +1,9 @@
# Rest Adapter # 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 ::: pyzipline.rest_adapter.RestAdapter

View file

@ -1,3 +1,3 @@
# API Reference # ZiplineApi
::: pyzipline.zipline.ZiplineApi ::: pyzipline.zipline.ZiplineApi

View file

@ -14,18 +14,19 @@ nav:
- Installation: getting-started/installation.md - Installation: getting-started/installation.md
- Usage: getting-started/usage.md - Usage: getting-started/usage.md
- Reference: - Reference:
- Zipline: ref/zipline.md - ZiplineApi: ref/zipline.md
- Utilities: ref/utils.md - Utilities: ref/utils.md
- Exceptions: ref/exceptions.md - Exceptions: ref/exceptions.md
- Models: ref/models.md - Models: ref/models.md
- Rest Adapter: ref/rest_adapter.md - Rest Adapter: ref/rest_adapter.md
plugins: plugins:
- git-revision-date-localized:
enable_creation_date: true
- git-authors - git-authors
- search - search
- social - social
- git-revision-date-localized:
enable_creation_date: true
type: timeago
- mkdocstrings: - mkdocstrings:
default_handler: python default_handler: python
handlers: handlers:
@ -63,11 +64,13 @@ theme:
features: features:
- content.code.annotate - content.code.annotate
- content.code.copy - content.code.copy
- content.tooltips
- navigation.instant - navigation.instant
- navigation.tabs - navigation.tabs
- search.suggest - search.suggest
- search.highlight - search.highlight
- search.share - search.share
logo: logo.png logo: img/logo.png
favicon: logo.png favicon: img/logo.png
watch:
- ./pyzipline

View file

@ -5,7 +5,7 @@ from json import JSONDecodeError
import requests import requests
from urllib3 import disable_warnings from urllib3 import disable_warnings
from pyzipline.errors import HTTPFailure, PyZiplineError from pyzipline.exceptions import HTTPFailure, PyZiplineError
from pyzipline.models import Result from pyzipline.models import Result
class RestAdapter: class RestAdapter: