From 6cc8a2dd0b3335eca7325da102776dff361ead4e Mon Sep 17 00:00:00 2001 From: SeaswimmerTheFsh Date: Wed, 20 Dec 2023 14:28:15 -0500 Subject: [PATCH] updating docs more --- docs/css/external.css | 13 ------------- docs/getting-started/installation.md | 28 +++++++++++++++++++++++----- docs/index.md | 6 +++--- mkdocs.yml | 7 ++++--- poetry.lock | 16 +++++++++++++++- pyproject.toml | 1 + pyzipline/zipline.py | 3 +-- 7 files changed, 47 insertions(+), 27 deletions(-) delete mode 100644 docs/css/external.css diff --git a/docs/css/external.css b/docs/css/external.css deleted file mode 100644 index 84299b3..0000000 --- a/docs/css/external.css +++ /dev/null @@ -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); -} diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index d114e66..21b9384 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -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 ``` diff --git a/docs/index.md b/docs/index.md index 4f55c73..bcd43a9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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). diff --git a/mkdocs.yml b/mkdocs.yml index 2a50c97..3003882 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -18,6 +18,7 @@ nav: plugins: - git-revision-date-localized: enable_creation_date: true + - git-authors - search - social # - mkdocstrings: @@ -29,6 +30,7 @@ plugins: markdown_extensions: - abbr - attr_list + - md_in_html - pymdownx.blocks.details - pymdownx.blocks.admonition - pymdownx.saneheaders @@ -45,17 +47,16 @@ markdown_extensions: emoji_index: !!python/name:pymdownx.emoji.twemoji emoji_generator: !!python/name:pymdownx.emoji.to_svg -extra_css: - - css/external.css - theme: name: material palette: scheme: slate features: + - content.code.annotate - content.code.copy - content.tooltips - navigation.instant + - navigation.tabs - search.suggest - search.highlight - search.share diff --git a/poetry.lock b/poetry.lock index 14f1034..21f301d 100644 --- a/poetry.lock +++ b/poetry.lock @@ -791,6 +791,20 @@ files = [ Markdown = ">=3.3" mkdocs = ">=1.1" +[[package]] +name = "mkdocs-git-authors-plugin" +version = "0.7.2" +description = "Mkdocs plugin to display git authors of a page" +optional = false +python-versions = ">=3.7" +files = [ + {file = "mkdocs-git-authors-plugin-0.7.2.tar.gz", hash = "sha256:f541730e4cabdafa0ac758c94d28ba5e8ddca4c859e5de4c89f1226cb6ccd0ad"}, + {file = "mkdocs_git_authors_plugin-0.7.2-py3-none-any.whl", hash = "sha256:c8a2784a867db79ad3b477a96ee96875d17b09192b6d3be71f08df25afff76c4"}, +] + +[package.dependencies] +mkdocs = ">=1.0" + [[package]] name = "mkdocs-git-revision-date-localized-plugin" version = "1.2.2" @@ -1619,4 +1633,4 @@ multidict = ">=4.0" [metadata] lock-version = "2.0" python-versions = "^3.10 || ^3.11 || ^3.12" -content-hash = "7f033bf18f67a3fb4a4b9e15d8f6463f34152daab215ab5d113d6cf5df127411" +content-hash = "4a37211d89e134df27183ed799df55662694232bcc6aef27f99f47c131186940" diff --git a/pyproject.toml b/pyproject.toml index 560f7e9..b3cd94d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -24,6 +24,7 @@ optional = true [tool.poetry.group.docs.dependencies] mkdocs = "1.5.3" mkdocstrings = "0.24.0" +mkdocs-git-authors-plugin = "0.7.2" mkdocs-git-revision-date-localized-plugin = "1.2.2" mkdocs-material = {extras = ["imaging"], version = "^9.5.2"} diff --git a/pyzipline/zipline.py b/pyzipline/zipline.py index 05dc920..ff3e671 100644 --- a/pyzipline/zipline.py +++ b/pyzipline/zipline.py @@ -28,8 +28,7 @@ class ZiplineApi: def get_user(self, user_id: int) -> User: """Get a user by ID - :param user_id: Integer ID of the user - :type user_id: int + user_id (int): Integer ID of the user to retrieve :return: The :class:`pyzipline.models.User` object matching the ID :rtype: :class:`pyzipline.models.User` """