-
Notifications
You must be signed in to change notification settings - Fork 12
/
mkdocs.yml
135 lines (127 loc) · 4.16 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
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
# Website Info
site_name: BastionLab
site_url: https://bastionlab.readthedocs.io/en/latest/
site_author: Mithril Security
site_description: >-
Create a simple privacy framework for data science collaboration,
covering data exploration and machine learning.
# Repository
repo_name: mithril-security/bastionlab
repo_url: https://github.com/mithril-security/bastionlab
# Configuration
theme:
name: material
custom_dir: docs/material_theme_customization
features:
- navigation.instant
- search.highlight
- content.tabs.link
- navigation.sections
- navigation.indexes
# - navigation.expand
logo: assets/logo.png
favicon: assets/logo.png
palette:
- scheme: slate
toggle:
icon: material/weather-sunny
- scheme: default
toggle:
icon: material/weather-night
icon:
admonition:
note: material/pencil-circle
abstract: material/list-box-outline
info: material/information-outline
tip: material/fire
success: material/check
question: material/help-circle
warning: material/alert
failure: material/window-close
danger: material/lightning-bolt-circle
bug: material/shield-bug
example: material/test-tube
quote: material/format-quote-close
#Plugins
plugins:
- search
- mkdocs-jupyter
# - gen-files:
# scripts:
# - docs/gen_ref_pages.py
# - mkdocstrings
# Customization
extra:
homepage: https://mithrilsecurity.io
social:
- icon: fontawesome/brands/discord
link: https://discord.com/invite/TxEHagpWd4
- icon: fontawesome/brands/github
link: https://github.com/mithril-security/
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/company/mithril-security-company/
- icon: fontawesome/brands/twitter
link: https://twitter.com/mithrilsecurity
extra_css:
- stylesheets/extra.css
extra_javascript:
- "https://code.jquery.com/jquery-3.3.1.min.js"
- javascripts/navbar.js
# Extensions
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- pymdownx.details
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.critic
# Documentation tree
nav:
- 🏠 Home: "index.md"
- 🚀 Getting started:
- Quick tour: "docs/quick-tour/quick-tour.ipynb"
- Installation: "docs/getting-started/installation.md"
- 📙 Tutorials:
- Authentication: "docs/tutorials/authentication.ipynb"
- Defining a privacy policy: "docs/tutorials/defining_policy_privacy.ipynb"
- Combining datasets: "docs/tutorials/combining_datasets.ipynb"
- Data cleaning: "docs/tutorials/data_cleaning.ipynb"
- SQL queries: "docs/tutorials/SQL_queries.ipynb"
- Data visualization: "docs/tutorials/visualization.ipynb"
- Saving DataFrames: "docs/tutorials/saving_dataframes.ipynb"
- Normalization: "docs/tutorials/normalization.ipynb"
- 🌍 How-to-guides:
- Data exploration:
- Covid-19 data analysis: "docs/how-to-guides/covid_cleaning_exploration.ipynb"
- Fraud detection data analysis: "docs/how-to-guides/fraud_detection.ipynb"
- Deep learning:
- Fine Tuning DistilBERT: "docs/how-to-guides/distilbert_example_notebook.ipynb"
- 💡 Concepts:
- Remote data science: "docs/concepts-guides/remote_data_science.md"
- 🛠️ API Reference:
- Sub-modules:
- 🔒 Security:
- Threat model: "docs/security/threat_model_data_owner_owns_infrastructure.md"
- Authentication specifications: "docs/security/authenticated_sessions.md"
- ⚙️ Advanced:
- Benchmarks:
- Polars: "docs/advanced/benchmarks/polars_benchmarks.md"
- Torch: "docs/advanced/benchmarks/torch_benchmarks.md"
- Open source:
- Contributing: "docs/advanced/contributing/contributing.md"
- Code of Conduct: "docs/advanced/contributing/code_of_conduct.md"