PyZipline/mkdocs.yml

79 lines
1.9 KiB
YAML

site_name: PyZipline Documentation
site_url: https://pyzipline.readthedocs.io
repo_name: CoastalCommits
repo_url: https://coastalcommits.com/SeaswimmerTheFsh/PyZipline
edit_uri: src/branch/main/docs
copyright: Copyright © 2023, SeaswimmerTheFsh
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
- Reference:
- ZiplineApi: ref/zipline.md
- Utilities: ref/utils.md
- Exceptions: ref/exceptions.md
- Models: ref/models.md
- Rest Adapter: ref/rest_adapter.md
plugins:
- git-authors
- search
- social
- 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
show_root_toc_entry: false
filters:
- "!^___"
markdown_extensions:
- abbr
- attr_list
- md_in_html
- 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:
emoji_index: !!python/name:pymdownx.emoji.twemoji
emoji_generator: !!python/name:pymdownx.emoji.to_svg
theme:
name: material
palette:
scheme: slate
features:
- content.code.annotate
- content.code.copy
- navigation.instant
- navigation.tabs
- search.suggest
- search.highlight
- search.share
logo: img/logo.png
favicon: img/logo.png
watch:
- ./pyzipline