PaperTrail/mkdocs.yml at main · bschilder/PaperTrail · 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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
site_name: PaperTrail
site_url: https://bschilder.github.io/PaperTrail
site_description: Every paper your team shares — found and mapped.
site_author: Brian Schilder
repo_url: https://github.com/bschilder/PaperTrail
repo_name: bschilder/PaperTrail

theme:
  name: material
  custom_dir: docs/overrides
  palette:
    # Dark mode first (matches PyTorch/RTD aesthetic)
    - media: "(prefers-color-scheme)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-2
        name: Switch to system preference
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.indexes
    - navigation.path
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - toc.follow
    - header.autohide
  icon:
    repo: fontawesome/brands/github
    logo: material/book-open-page-variant
  font:
    text: Inter
    code: JetBrains Mono

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_source: false
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            heading_level: 2
            members_order: source
            docstring_style: numpy
            docstring_section_style: spacy
            merge_init_into_class: true
            show_signature_annotations: true
            separate_signature: true
            signature_crossrefs: true
            show_if_no_docstring: false
            annotations_path: brief

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.arithmatex:
      generic: true
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
      toc_depth: 3

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Configuration: getting-started/configuration.md
    - Quick Start: getting-started/quickstart.md
  - User Guide:
    - Scraping Papers: guide/scraping.md
    - Enriching Metadata: guide/enriching.md
    - Computing Embeddings: guide/embeddings.md
    - Building the Dashboard: guide/dashboard.md
    - Searching Papers: guide/searching.md
  - API Reference:
    - Data: api/data.md
    - Scraper: api/scraper.md
    - Enricher: api/enricher.md
    - Embeddings: api/embeddings.md
    - Projections: api/projections.md
    - Preview: api/preview.md
    - CLI: api/cli.md
  - Examples:
    - Koo Lab Demo: examples/koo-lab.md
  - Contributing: contributing.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/bschilder/PaperTrail
  version:
    provider: mike

extra_css:
  - stylesheets/extra.css