_pkgdown.yml

url: https://dfe-analytical-services.github.io/eesyapi/
template:
  bootstrap: 5
  bootswatch: cyborg
  bslib:
    pkgdown-nav-height: 81.4468px

reference:
- title: Primary API workflow tools for analysts
  desc: These are the functions we expect analysts will most likely want to use to connect to the EES API.
  contents:
  - get_publications
  - get_data_catalogue
  - get_dataset_versions
  - get_meta
  - preview_dataset
  - query_dataset

- title: Support for generating API URLs and interpreting responses
  desc: These functions are helpful for deriving urls and handling HTTP responses and are used widely by the API workflow functions.
  contents:
  - starts_with("api_url")

- title: Generate example IDs and reference data
  desc: These functions are used widely to create working example code and tests
  contents:
  - starts_with("example")
  - geog_level_lookup

- title: Explore education statistics format convertors
  desc: Helpers to convert the output data into a standard format used in the main data ingestion from explore education statistics
  contents:
  - generate_ees_meta