mkdocs.yml

#
# Copyright (C) 2024 DANS - Data Archiving and Networked Services (info@dans.knaw.nl)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

site_name: dd-dataverse-ingest
theme:
  name: readthedocs

repo_name: DANS-KNAW/dd-dataverse-ingest
repo_url: https://github.com/DANS-KNAW/dd-dataverse-ingest

nav:
  - Manual:
      - Introduction: index.md
      - Description: description.md
      #      - Examples: examples.md
      - Installation: install.md
  - Development:
      - Overview: dev.md
  - Context: arch.md

extra:
  bagit_specs_url: https://www.rfc-editor.org/rfc/rfc8493.html
  dans_bag_profile_url: https://dans-knaw.github.io/dans-bagit-profile/versions/1.2.0/
  dataverse_api_url: https://guides.dataverse.org/en/latest/api
  validate_dans_bag_url: https://github.com/DANS-KNAW/dd-validate-dans-bag
  dataverse_ingest_cli_url: https://github.com/DANS-KNAW/dd-dataverse-ingest-cli

plugins:
  - markdownextradata
  - search

markdown_extensions:
  - attr_list
  - admonition
  - codehilite:
      guess_lang: False
      use_pygments: False
  - def_list
  - footnotes
  - meta
  - toc:
      permalink: True