PyZipline/mkdocs.yml
SeaswimmerTheFsh 3fbae612ff
Some checks failed
Pylint / Pylint (3.12) (push) Failing after 37s
feat(docs): adding more documentation and customization
2023-12-20 13:36:33 -05:00

63 lines
1.5 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: ref/zipline.md
plugins:
- git-revision-date-localized:
enable_creation_date: true
- search
- social
# - mkdocstrings:
# default_handler: python
# handlers:
# python:
# paths: [pyzipline]
markdown_extensions:
- abbr
- attr_list
- 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
extra_css:
- css/external.css
theme:
name: material
palette:
scheme: slate
features:
- content.code.copy
- content.tooltips
- navigation.instant
- search.suggest
- search.highlight
- search.share
logo: logo.png
favicon: logo.png