API_UG.yml

---
#
# GDC Docs - Config
#

site_name: GDC Docs
site_url: https://docs.gdc.cancer.gov
repo_url: https://github.com/NCI-GDC/gdc-docs
copyright: '© 2015-2024'
nav:
  - API:
      - Home: index.md
      - Getting Started: API/Users_Guide/Getting_Started.md
      - Search and Retrieval: API/Users_Guide/Search_and_Retrieval.md
      - Downloading Files: API/Users_Guide/Downloading_Files.md
      - Data Analysis: API/Users_Guide/Data_Analysis.md
      - BAM Slicing: API/Users_Guide/BAM_Slicing.md
      - Submission: API/Users_Guide/Submission.md
      - Python Examples: API/Users_Guide/Python_Examples.md
      - GraphQL Examples: API/Users_Guide/GraphQL_Examples.md
      - System Information: API/Users_Guide/System_Information.md
      - Additional Examples: API/Users_Guide/Additional_Examples.md
      - 'Appendix A: Available Fields': API/Users_Guide/Appendix_A_Available_Fields.md
      - 'Appendix B: Key Terms': API/Users_Guide/Appendix_B_Key_Terms.md
      - 'Appendix C: Format of Submission Queries and Responses': API/Users_Guide/Appendix_C_Format_of_Submission_Requests_and_Responses.md
      - Release Notes: API/Release_Notes/API_Release_Notes.md
extra:
  project_root_dir: /
  project_org: GDC
  project_description: GDC Docs
  version: 1.0
theme:
  custom_dir: overrides
  favicon: images/favicon.ico
  features:
    - navigation.tabs
    - navigation.tabs.sticky
  logo: images/nih-header-logo-color.png
  name: material
  palette:
    primary: white
    scheme: gdc-accessible
markdown_extensions:
  - tables
  - pymdownx.superfences
  - pymdownx.tabbed:
      combine_header_slug: true
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.details
plugins:
  - with-pdf:
      author: NCI GDC
      cover_title: GDC API User's Guide
      cover_subtitle: NCI Genomic Data Commons (GDC)
      cover_logo: docs/images/nih-header-logo-color.png
      toc_level: 3
      exclude_pages:
        - ^$
      enabled_if_env: ENABLE_PDF_EXPORT
      render_js: false
      output_path: ../docs/API/PDF/API_UG.pdf