-
Notifications
You must be signed in to change notification settings - Fork 26
/
mkdocs.yml
103 lines (95 loc) · 2.86 KB
/
mkdocs.yml
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
site_name: "PUMA: Plotting UMami Api"
site_description: Documentation for the PUMA plotting framework
site_author: Umami Team
site_url: https://umami-hep.github.io/puma/
repo_name: Github
repo_url: https://github.com/umami-hep/puma
edit_uri: "tree/main/docs"
theme:
name: material
features:
- content.code.copy
- navigation.tabs
- navigation.tabs.sticky
- navigation.sections
- navigation.indexes
- navigation.top
- toc.follow
palette:
- scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode
nav:
- Introduction: index.md
- Examples:
- Examples: examples/index.md
- Dummy Data: examples/dummy_data.md
- Histograms: examples/histograms.md
- ROC curves: examples/rocs.md
- Integrated efficiency plot: examples/int_eff.md
- Variable vs efficiency Plots: examples/var_vs_eff.md
- Fraction Scan Plots: examples/fraction_scan.md
- Pie charts: examples/pie_charts.md
- Line plots: examples/line_plots.md
- High level API:
- High level API: hlapi/index.md
- High level API for aux task plots: hlapi/high_level_aux_api.md
- Number of Tracks per Jet per Origin: hlapi/n_track_origin.md
- YUMA (Yaml Plotting): hlapi/yuma.md
- Tutorial: examples/tutorial-plotting.md
- Contributing:
- dev/development_guidelines.md
- API Reference:
- Plot Base: api/plot_base.md
- Histogram: api/histogram.md
- ROC: api/roc.md
- Integrated Efficiency: api/int_eff.md
- Variable vs Variable: api/var_vs_var.md
- Fraction Scan: api/fraction_scan.md
- Pie Chart: api/pie_chart.md
plugins:
- search
- markdownextradata
- git-revision-date-localized:
enable_creation_date: true
type: date
- autorefs
- mkdocstrings:
handlers:
python:
options:
paths: [puma]
line_length: 100
show_root_heading: true
show_root_toc_entry: true
show_root_full_path: true
docstring_style: numpy
merge_init_into_class: true
annotations_path: full
show_signature: false
# members: false
markdown_extensions:
- admonition
- codehilite
- pymdownx.arithmatex
- pymdownx.details
- pymdownx.inlinehilite
- pymdownx.smartsymbols
- pymdownx.snippets
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: "!!python/name:mermaid2.fence_mermaid"
- pymdownx.tabbed:
alternate_style: true
- toc:
permalink: "#"
extra_javascript:
- "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML"
copyright: Copyright © 2022 - 2023 CERN for the benefit of the ATLAS collaboration