From 6a250a24fb6c63a27f3acbb696e9fd8627b64cbd Mon Sep 17 00:00:00 2001 From: SeaswimmerTheFsh Date: Wed, 20 Dec 2023 20:48:18 -0500 Subject: [PATCH] docs: update stuff or something --- .gitignore | 1 + README.md | 3 ++- docs/{ => img}/logo.png | Bin docs/{ => img}/text.png | Bin docs/ref/errors.md | 3 --- docs/ref/exceptions.md | 3 +++ docs/ref/rest_adapter.md | 6 ++++++ docs/ref/zipline.md | 2 +- mkdocs.yml | 15 +++++++++------ pyzipline/{errors.py => exceptions.py} | 0 pyzipline/rest_adapter.py | 2 +- 11 files changed, 23 insertions(+), 12 deletions(-) rename docs/{ => img}/logo.png (100%) rename docs/{ => img}/text.png (100%) delete mode 100644 docs/ref/errors.md create mode 100644 docs/ref/exceptions.md rename pyzipline/{errors.py => exceptions.py} (100%) diff --git a/.gitignore b/.gitignore index b322e0d..7fd2914 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ __pycache__ .cache +.zipline diff --git a/README.md b/README.md index 32f222d..d689aff 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ # 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). diff --git a/docs/logo.png b/docs/img/logo.png similarity index 100% rename from docs/logo.png rename to docs/img/logo.png diff --git a/docs/text.png b/docs/img/text.png similarity index 100% rename from docs/text.png rename to docs/img/text.png diff --git a/docs/ref/errors.md b/docs/ref/errors.md deleted file mode 100644 index 023c9f8..0000000 --- a/docs/ref/errors.md +++ /dev/null @@ -1,3 +0,0 @@ -# Exceptions - -::: pyzipline.errors diff --git a/docs/ref/exceptions.md b/docs/ref/exceptions.md new file mode 100644 index 0000000..a59e618 --- /dev/null +++ b/docs/ref/exceptions.md @@ -0,0 +1,3 @@ +# Exceptions + +::: pyzipline.exceptions diff --git a/docs/ref/rest_adapter.md b/docs/ref/rest_adapter.md index 3df0af2..034ddde 100644 --- a/docs/ref/rest_adapter.md +++ b/docs/ref/rest_adapter.md @@ -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 diff --git a/docs/ref/zipline.md b/docs/ref/zipline.md index ba45086..1bf0616 100644 --- a/docs/ref/zipline.md +++ b/docs/ref/zipline.md @@ -1,3 +1,3 @@ -# API Reference +# ZiplineApi ::: pyzipline.zipline.ZiplineApi diff --git a/mkdocs.yml b/mkdocs.yml index 8991a13..cb594f7 100644 --- a/mkdocs.yml +++ b/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 diff --git a/pyzipline/errors.py b/pyzipline/exceptions.py similarity index 100% rename from pyzipline/errors.py rename to pyzipline/exceptions.py diff --git a/pyzipline/rest_adapter.py b/pyzipline/rest_adapter.py index 582cf67..283a402 100644 --- a/pyzipline/rest_adapter.py +++ b/pyzipline/rest_adapter.py @@ -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: