Denario/mkdocs.yml at master · AstroPilot-AI/Denario · 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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
site_name: Denario
repo_url: https://github.com/AstroPilot-AI/Denario
site_url: !ENV READTHEDOCS_CANONICAL_URL

nav:
  - Home: index.md
  - Installation: install.md
  - LLM APIs:
      - Overview: llm_api_keys/apikeys.md
      - Cost: llm_api_keys/cost.md
      - Obtaining API Keys: llm_api_keys/obtaining-api-keys.md
      - Vertex AI Setup: llm_api_keys/vertex-ai-setup.md
      - Storing API Keys: llm_api_keys/storing-api-keys.md
  - Get started: get_started.md
  - App: app.md
  - Docker: docker.md
  - Prompts: prompts.md
  - Examples:
      - End-to-end research: examples/denario_oscillator_full_run.ipynb
      - Enhance input description: examples/enhance_input.ipynb
      - Generate research ideas: examples/research_idea.ipynb
      - Literature search: examples/idea_check.ipynb
      - Write a paper: examples/write_paper.ipynb
      - End-to-end Gemini+fast mode: examples/EtE_Gemini_fast.ipynb
  - Video tutorials:
      - LLM API Credentials: tutorials/tut_llm_api.md
      - Installation: tutorials/tut_install.md
      - End to end research: tutorials/tut_end2end.md
      - Graphical User Interface: tutorials/tut_gui.md
  - Troubleshooting: troubleshooting.md
  - Resources: resources.md
  - API Reference:
      - Denario: api_ref/api_denario.md
      - Classes: api_ref/api_classes.md
      - LLMs: api_ref/api_llms.md
      - Paper: api_ref/api_paper.md
      - Journals: api_ref/api_journals.md
      - Utils: api_ref/api_utils.md

theme:
  name: material
  features:
    - content.code.copy
    - navigation.footer
    - navigation.tracking
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
      primary: deep purple
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
      primary: deep purple

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_source: true
            docstring_style: google
            annotations_path: brief
            show_signature: true
            separate_signature: true
            show_root_toc_entry: false
            show_root_members_full_path: true
            merge_init_into_class: true
            show_signature_annotations: true
            # show_root_heading: true
            filters:
              - "!^_"
  - mkdocs-jupyter:
      include_source: True
      execute: False
      ignore_h1_titles: True
  - git-committers:
      repository: AstroPilot-AI/Denario
      branch: master

extra_css:
  - css/mkdocstrings.css
  - css/extra.css

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.snippets:
      base_path: "./"

extra:
  analytics:
    provider: google
    property: G-XRRM15GMS9