_pkgdown.yml

# This is to give a default value to the `mode` parameter in the
# `pkgdown::build_site` function. This is useful when building the site locally,
# as it will default to `devel` mode. In practice, this should all be handled
# dynamically by the CI/CD pipeline.
development:
  mode: devel

template:
  package: delphidocs

url: https://cmu-delphi.github.io/epidatr/

home:
  links:
    - text: Get the Python client
      href: https://github.com/cmu-delphi/epidatpy/
  sidebar:
    structure: [links, license, community, citation, authors, related, dev]
    components:
      related:
        title: Delphi packages and resources
        text: |
          * [The epiprocess R package](https://cmu-delphi.github.io/epiprocess/)
          * [The epipredict R package](https://cmu-delphi.github.io/epipredict/)
          * [The epidatasets R package](https://cmu-delphi.github.io/epidatasets/)
          * [Introduction to Delphi's Tooling Work](https://cmu-delphi.github.io/delphi-tooling-book/)


reference:
  - title: Data source and signal discovery
    desc: Quickly explore endpoints, and API signal and source names
  - contents:
      - avail_endpoints
      - covidcast_epidata
  - title: Make API requests
    desc: Query Delphi Epidata endpoints
  - contents:
      - epidata_call
      - fetch_args_list
      - has_keyword("endpoint")
      - -starts_with("pvt_")
  - title: Configuration and utilities
    desc: Set API keys and handle API data types
  - contents:
      - get_api_key
      - epirange
      - timeset
  - title: Control caching behavior
    desc: Configure an optional persistent cache
  - contents:
      - set_cache
      - clear_cache
      - disable_cache
      - cache_info
  - title: Make requests to private API endpoints
    desc: These endpoints require additional authorization to use
  - contents:
      - starts_with("pvt_")