pydoc-markdown.yml

loaders:
- type: python
  search_path: [..]
processors:
- type: filter
- type: pydoc_markdown_tqdm.TqdmProcessor
- type: crossref
hooks:
  pre-render:
  - test -d ../wiki || git clone https://github.com/tqdm/tqdm.wiki.git ../wiki
  - GITHUB_API_TOKEN='' python ../wiki/releases.py tqdm/tqdm -o sources/releases.md -d ext
  post-render:
  - cp sources/ads.txt build/docs/content/
renderer:
  type: mkdocs
  markdown:
    source_linker:
      type: github
      repo: tqdm/tqdm
      root: ..
    source_position: before signature
    source_format: |
      <span style="float: right; font-size: 75%;">
      [[view source]]({url})
      </span>
  pages:
  - title: Home
    name: index
    source: sources/index.md
  - title: Library Reference
    name: docs
    children:
    - title: tqdm.tqdm
      name: tqdm
      contents: [tqdm.std.t*]
    - title: tqdm.notebook
      name: notebook
      contents: [tqdm.notebook.t*]
    - title: tqdm.asyncio
      name: asyncio
      contents: [tqdm.asyncio*]
    - title: tqdm.keras
      name: keras
      contents: [tqdm.keras*]
    - title: tqdm.dask
      name: dask
      contents: [tqdm.dask*]
    - title: tqdm.tk
      name: tk
      contents: [tqdm.tk.t*]
    - title: tqdm.gui
      name: gui
      contents: [tqdm.gui.t*]
    - title: tqdm.rich
      name: rich
      contents: [tqdm.rich.t*]
    - title: CLI
      name: cli
      source: sources/cli.md
    - title: tqdm.contrib
      name: contrib
      contents: [tqdm.contrib.tenumerate*, tqdm.contrib.tzip*, tqdm.contrib.tmap*]
    - title: tqdm.contrib.concurrent
      name: contrib.concurrent
      contents: [tqdm.contrib.concurrent*]
    - title: tqdm.contrib.itertools
      name: contrib.itertools
      contents: [tqdm.contrib.itertools*]
    - title: tqdm.contrib.logging
      name: contrib.logging
      contents: [tqdm.contrib.logging*]
    - title: tqdm.contrib.slack
      name: contrib.slack
      contents: [tqdm.contrib.slack.t*]
    - title: tqdm.contrib.discord
      name: contrib.discord
      contents: [tqdm.contrib.discord.t*]
    - title: tqdm.contrib.telegram
      name: contrib.telegram
      contents: [tqdm.contrib.telegram.t*]
    - title: tqdm.utils
      name: tqdm.utils
      contents: [tqdm.utils.CallbackIOWrapper, tqdm.utils.envwrap, tqdm.utils.disp_*]
    - title: Shortcuts
      # tqdm.trange tqdm.gui.tgrange, tqdm.notebook.tnrange, tqdm.contrib.telegram.ttgrange
      contents: [tqdm.autonotebook, tqdm.auto, tqdm.contrib.bells]
  - title: Developer Reference
    name: dev
    children:
    - title: Warnings and Exceptions
      name: warnings
      contents: [tqdm.std.Tqdm*]
    - title: tqdm.TMonitor
      name: TMonitor
      contents: [tqdm._monitor.TMonitor*]
  - title: Release History
    name: releases
    source: sources/releases.md
  - title: Contributing
    name: contributing
    source: ../CONTRIBUTING.md
  - title: Merch Store!
    name: merch
    source: sources/merch.md
  - title: Ports to Other Languages
    name: ports
    source: ../wiki/tqdm-ports.md
  - title: Presentation (PyData)
    children:
    - title: Video
      name: video
      source: sources/video.md
    - title: Slides
      href: PyData2019/slides.html
  - title: External Links
    children:
    - title: Source Code (ENTIRE DOCUMENTATION ON ONE PAGE)
      href: https://github.com/tqdm/tqdm
    - title: wiki
      href: https://github.com/tqdm/tqdm/wiki
    - title: FAQs
      href: https://github.com/tqdm/tqdm#faq-and-known-issues
    - title: Issues
      href: https://github.com/tqdm/tqdm/issues?q=
    - title: Downloads
      children:
      - title: GitHub
        href: https://github.com/tqdm/tqdm/releases
      - title: PyPI
        href: https://pypi.org/project/tqdm
      - title: Conda
        href: https://anaconda.org/conda-forge/tqdm
    - title: Tests
      children:
      - title: GitHub Actions
        href: https://github.com/tqdm/tqdm/actions?query=workflow%3ATest
      - title: Coveralls
        href: https://coveralls.io/github/tqdm/tqdm
      - title: Codecov
        href: https://codecov.io/gh/tqdm/tqdm
      - title: Codacy
        href: https://www.codacy.com/app/tqdm/tqdm
      - title: Performance Benchmarks (asv)
        href: https://tqdm.github.io/tqdm
    - title: Citations
      children:
      - title: DOI
        href: https://doi.org/10.5281/zenodo.595120
      - title: Metrics (Open Hub)
        href: https://www.openhub.net/p/tqdm
  - title: Licence
    name: licence
    source: ../LICENCE
  - title: Video
    name: video
    source: sources/video.md
  mkdocs_config:
    site_name: tqdm documentation
    site_description: A Fast, Extensible Progress Meter
    site_url: https://tqdm.github.io
    site_author: Casper da Costa-Luis
    repo_name: tqdm/tqdm
    repo_url: https://github.com/tqdm/tqdm
    copyright: |
      &copy; Casper da Costa-Luis <a href="https://github.com/casperdcl">@casperdcl</a> 2015-2022
    edit_uri: ../tqdm.github.io/tree/main/sources
    extra_css: [css/extra.css]

    extra:
      generator: false
      social:
      - icon: fontawesome/brands/github
        link: https://github.com/tqdm/tqdm
      - icon: fontawesome/brands/wikipedia-w
        link: https://github.com/tqdm/tqdm/wiki
      - icon: fontawesome/solid/circle-question
        link: https://github.com/tqdm/tqdm#faq-and-known-issues
      - icon: fontawesome/solid/clipboard-list
        link: /releases/
      - icon: fontawesome/brands/orcid
        link: https://doi.org/10.5281/zenodo.595120
      - icon: fontawesome/brands/youtube
        link: /video/
    theme:
      name: material
      logo: https://tqdm.github.io/img/logo-trans.gif
      favicon: https://tqdm.github.io/img/logo-trans.gif
      custom_dir: ../../custom_theme/
      palette:
      - scheme: default
        primary: indigo
        toggle:
          icon: material/toggle-switch-off-outline
          name: Switch to dark mode
      - scheme: slate
        primary: orange
        toggle:
          icon: material/toggle-switch
          name: Switch to light mode
    plugins:
    - search
    - minify:
        minify_js: true
        minify_html: true
    markdown_extensions:
    - admonition
    - toc:
        permalink: '#'
    - pymdownx.superfences