PyZipline/mkdocs.yml

105 lines
2.6 KiB
YAML
Raw Normal View History

2023-12-19 17:27:24 -05:00
site_name: PyZipline Documentation
site_url: !ENV [SITE_URL, 'https://seacogs.coastalcommits.com']
2023-12-19 17:27:24 -05:00
repo_name: CoastalCommits
repo_url: https://coastalcommits.com/SeaswimmerTheFsh/PyZipline
edit_uri: !ENV [EDIT_URI, 'src/branch/main/docs']
2024-01-15 06:26:08 -05:00
copyright: Copyright © 2023-2024, SeaswimmerTheFsh
2023-12-19 17:27:24 -05:00
site_author: SeaswimmerTheFsh
site_description: PyZipline is an API wrapper written in Python for the Zipline API.
nav:
- Home: index.md
- Getting Started:
- Installation: getting-started/installation.md
- Usage: getting-started/usage.md
2023-12-21 14:08:09 -05:00
- Versioning: getting-started/versioning.md
- Reference:
2023-12-20 20:48:18 -05:00
- ZiplineApi: ref/zipline.md
- Utilities: ref/utils.md
- Exceptions: ref/exceptions.md
- Models: ref/models.md
- Rest Adapter: ref/rest_adapter.md
2023-12-19 17:27:24 -05:00
plugins:
2023-12-20 14:28:15 -05:00
- git-authors
2023-12-19 17:27:24 -05:00
- search
2023-12-19 17:37:56 -05:00
- social
2023-12-20 20:48:18 -05:00
- git-revision-date-localized:
enable_creation_date: true
type: timeago
- mkdocstrings:
default_handler: python
handlers:
python:
paths: [pyzipline]
options:
docstring_options:
ignore_imit_summary: true
summary: true
2023-12-20 21:37:02 -05:00
show_root_toc_entry: false
filters:
- "!^___"
markdown_extensions:
- abbr
- attr_list
2023-12-20 14:28:15 -05:00
- md_in_html
2023-12-21 14:08:09 -05:00
- tables
- pymdownx.blocks.details
- pymdownx.blocks.admonition
- pymdownx.saneheaders
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.emoji:
2023-12-21 14:08:09 -05:00
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
2023-12-19 17:27:24 -05:00
theme:
name: material
palette:
- media: '(prefers-color-scheme: light)'
scheme: default
primary: cyan
accent: light blue
toggle:
icon: material/toggle-switch
name: Switch to dark mode
- media: '(prefers-color-scheme: dark)'
scheme: slate
primary: cyan
accent: light blue
toggle:
icon: material/toggle-switch-off-outline
name: Switch to light mode
2023-12-19 17:27:24 -05:00
features:
- announce.dismiss
2023-12-20 14:28:15 -05:00
- content.code.annotate
- content.code.copy
- navigation.instant
- navigation.instant.progress
2023-12-20 14:28:15 -05:00
- navigation.tabs
- navigation.tracking
- navigation.top
- navigation.sections
- navigation.indexes
2023-12-19 17:27:24 -05:00
- search.suggest
- search.highlight
- search.share
- toc.follow
2023-12-20 20:48:18 -05:00
logo: img/logo.png
favicon: img/logo.png
icon:
repo: simple/forgejo
2023-12-20 20:48:18 -05:00
watch:
- ./pyzipline