template-python-package/template/_quarto.yml.jinja at c595a6a7edd07948fc32f73dee612d086cff9ded · seedcase-project/template-python-package · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
project:
  # TODO: change to extension name if using a custom extension
  type: website

website:
  # TODO: Fill in the title of the website.
  title: ""
  {% if hosting_provider == "gh-pages" -%}
  site-url: "https://{{ github_user }}.github.io/{{ github_repo }}/"
  {%- elif hosting_provider == "netlify" -%}
  # TODO: Set the Netlify custom domain URL
  site-url: "{{ homepage }}"
  {%- endif %}
  repo-url: "https://github.com/{{ github_repo_spec }}"
  page-navigation: true
  navbar:
    pinned: true
    title: false
    {%- if is_seedcase_project %}
    logo: "_extensions/seedcase-project/seedcase-theme/logos/{{ github_repo }}/navbar.svg"
    logo-alt: "{{ github_repo }} logo: Main page"
    {%- else %}
    # TODO: add logo
    logo: ""
    logo-alt: "{{ github_repo }} logo: Main page"
    {%- endif %}
    left:
      - text: "Overview"
        href: docs/index.qmd
      - text: "Guide"
        href: docs/guide/index.qmd
      - text: "Design"
        href: docs/design/index.qmd
      # - text: "Reference"
      #   href: docs/reference/index.qmd
    tools:
      - icon: github
        href: "https://github.com/{{ github_repo_spec }}"
        aria-label: "GitHub icon: Source code"
      {%- if is_seedcase_project %}
      - icon: house
        href: "https://seedcase-project.org"
        aria-label: "House icon: Main website for the Seedcase Project"
      {%- endif %}
  sidebar:
    - id: overview
      pinned: true
      style: "floating"
      contents:
        - docs/index.qmd
        - CHANGELOG.qmd
        - CONTRIBUTING.md
    - id: design
      contents:
        - text: "Design"
          href: docs/design/index.qmd
    - id: guide
      contents:
        - section: "Guide"
          href: docs/guide/index.qmd

quartodoc:
  sidebar: "docs/reference/_sidebar.yml"
  style: "pkgdown"
  dir: "docs/reference"
  package: "{{ github_repo_snake_case }}"
  parser: google
  dynamic: true
  renderer:
    style: _renderer.py
    table_style: description-list
    show_signature_annotations: true

metadata-files:
  - docs/reference/_sidebar.yml

format:
  {% if is_seedcase_project -%}
  seedcase-theme-html:
    theme:
      - brand
  {%- else -%}
  # TODO: Use Quarto extension if available
  html:
    theme:
      # TODO: Choose a different theme if desired
      - litera
  {%- endif %}
    # TODO: Uncomment if using the goatcounter website visitor counter
    # include-before-body:
      # - "docs/includes/site-counter.html"