pydoc-markdown.yml

loaders:
  - type: python
    search_path: [yfs]

processors:
  - type: filter
  - type: google
  - type: crossref

renderer:
  type: mkdocs

  markdown:
    signature_with_decorators: False
    signature_in_header: False
    signature_with_def: True
    descriptive_class_title: False
    descriptive_module_title: True
    add_method_class_prefix: False
    add_member_class_prefix: False
    classdef_code_block: False
    classdef_render_init_signature_if_needed: True
    signature_code_block: True
    render_module_header: False
    insert_header_anchors: True
    code_lang: True
    html_headers: False
    code_headers: True
    docstrings_as_blockquote: True

  output_directory: "docs"

  site_name: YFS
  clean_render: True
  pages:
    - title: Home
      name: index
      source: README.md

    - title: Changelog
      name: changelog
      source: CHANGELOG.md

    - title: Examples
      name: examples
      children:
        - title: "Fuzzy Search Examples"
          source: ./docs/markdown/lookup_examples.md

        - title: "Statistics Page Examples"
          source: ./docs/markdown/statistics_examples.md

        - title: "Summary Page Examples"
          source: ./docs/markdown/summary_examples.md

        - title: "Extra Watchlist Example"
          source: ./docs/markdown/watchlist_example.md

    - title: API Documentation
      name: api
      children:
        - title: "Asset Types Module"
          contents:
          - asset_types.*

        - title: "Cleaner Module"
          contents:
          - cleaner.*

        - title: "Exchanges Module"
          contents:
          - exchanges.*

        - title: "Lookup Module"
          contents:
          - lookup.*

        - title: "Options Module"
          contents:
          - options.*

        - title: "Paths Module"
          contents:
          - paths.*

        - title: "Quote Module"
          contents:
          - quote.*

        - title: "Requestor Module"
          contents:
          - requestor.*

        - title: "Statistics Module"
          contents:
          - statistics.*

        - title: "Summary Module"
          contents:
          - summary.*

  mkdocs_config:
    repo_url: https://github.com/dgnsrekt/yfs
    theme:
      name: material
      palette:
        primary: deep purple
        accent: indigo
        scheme: slate

      icon:
        repo: fontawesome/brands/github-alt

      custom_dir: overrides

    markdown_extensions:
      - pymdownx.highlight
      - pymdownx.superfences
      - admonition
      - attr_list

      - pymdownx.caret
      - pymdownx.mark
      - pymdownx.tilde
      - pymdownx.details

      - pymdownx.tasklist:
          custom_checkbox: true

      - pymdownx.betterem:
          smart_enable: all

    extra:
      social:
        - icon: fontawesome/brands/twitter
          link: https://twitter.com/dgnsrekt
          name: dgnsrekt on twitter

        - icon: fontawesome/brands/github
          link: https://github.com/dgnsrekt
          name: dgnsrekt on twitter

        - icon: fontawesome/brands/telegram
          link: https://t.me/dgnsrekt
          name: dgnsrekt on twitter

        - icon: fontawesome/solid/paper-plane
          link: mailto:dgnsrekt@pm.me