_pkgdown.yml

url: https://mrc-ide.github.io/orderly2

template:
  bootstrap: 5

articles:
  - title: Introduction
    navbar: Introduction
    contents:
      - orderly2
      - introduction
      - dependencies
      - collaboration
      - troubleshooting

  - title: Advanced topics
    navbar: Advanced topics
    contents:
      - migrating
      - metadata
      - query
      - plugins

reference:
  - title: Run a report
    contents:
      - orderly_run
      - orderly_list_src
  - title: From within a running report
    desc: >-
      These are the functions that get called from your orderly file
    contents:
      - orderly_strict_mode
      - orderly_parameters
      - orderly_description
      - orderly_resource
      - orderly_shared_resource
      - orderly_dependency
      - orderly_artefact
      - orderly_run_info
  - title: Read packet metadata
    contents:
      - orderly_metadata
      - orderly_metadata_read
      - orderly_metadata_extract
  - title: Search
    contents:
      - orderly_query
      - orderly_search_options
      - orderly_search
      - orderly_query_explain
  - title: Initialise and configure
    contents:
      - orderly_init
      - orderly_config
      - orderly_config_set
  - title: Interact with locations
  - subtitle: Use locations
    contents:
      - orderly_location_fetch_metadata
      - orderly_location_pull
      - orderly_location_push
  - subtitle: Manage locations
    contents:
      - orderly_location_add
      - orderly_location_add_path
      - orderly_location_add_http
      - orderly_location_add_packit
      - orderly_location_list
      - orderly_location_remove
      - orderly_location_rename
  - title: Help for developing
    contents:
      - orderly_new
      - orderly_cleanup
      - orderly_cleanup_status
      - orderly_gitignore_update
      - orderly_interactive_set_search_options
  - title: Create plugins
    contents:
      - orderly_plugin_add_metadata
      - orderly_plugin_context
      - orderly_plugin_register
  - title: Everything else
    contents:
      - orderly_copy_files
      - orderly_example
      - orderly_prune_orphans
      - orderly_validate_archive
      - orderly_hash_data
      - orderly_hash_file
      - orderly_parse_file
      - orderly_parse_expr
      - orderly_compare_packets
      - orderly_comparison_explain