_pkgdown.yml

template:
  params:
    bootswatch: cerulean
articles:
 - title: "Getting Started"
   navbar: "Getting Started"
   contents:
    - setup
    - articles/getting-started
 - title: "Examples & Recipes"
   navbar: "Examples & Recipes"
   contents:
     - articles/calculating-time-on-task
     - articles/analysis-of-grades
     - articles/forecast-example

reference:
  - title: "Data Access"
    desc: >
      Functions for accessing Moodle data or data in the local cache of Moodle
      tables.
  - contents:
    - mdl_config
    - mdl_courses
    - mdl_forum_posts
    - mdl_grades
    - mdl_log
    - mdl_users
  - title: "Connections and Caching"
    desc: >
       Functions for configuring database access, downloading dataand setting
       up a local cache.
  - contents:
    - mdl_get_connection
    - mdl_get_cache_connection
    - mdl_create_cache
  - title: "Summary Functions"
    desc: >
       Summary functions with sensible defaults for the domain in question.
  - contents:
    - starts_with("summary.")
  - title: "Plot Functions"
    desc: >
       Plot functions with sensible defaults for the domain in question.
  - contents:
    - starts_with("plot.")
  - title: "Print Functions"
    desc: >
       Print functions with sensible defaults for the domain in question.
  - contents:
    - starts_with("print.")
  - title: "Check Function"
    desc: >
       Checks if cache has been created correctly.
  - contents:
    - starts_with("check_")
  - title: "Cache Paths"
    desc: >
       Gets the cache directory and filename.
  - contents:
    - mdl_get_cache_dir
    - mdl_get_cache_filename
  - title: "Config Template"
    desc: >
       Creates an example config.yml file and opens it for editing.
  - contents:
    - example_config_yml