Skip to content

Commit 909831c

Browse files
Add mkdocs config with existing guide pages
1 parent b6eb822 commit 909831c

File tree

1 file changed

+122
-0
lines changed

1 file changed

+122
-0
lines changed

mkdocs.yml

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
site_name: TensorFlow Data Transform
2+
repo_name: "transform"
3+
repo_url: https://github.com/tensorflow/transform
4+
5+
theme:
6+
logo: images/tf_full_color_primary_icon.svg
7+
name: material
8+
palette:
9+
# Palette toggle for automatic mode
10+
- media: "(prefers-color-scheme)"
11+
primary: custom
12+
accent: custom
13+
toggle:
14+
icon: material/brightness-auto
15+
name: Switch to light mode
16+
17+
# Palette toggle for light mode
18+
- media: "(prefers-color-scheme: light)"
19+
primary: custom
20+
accent: custom
21+
scheme: default
22+
toggle:
23+
icon: material/brightness-7
24+
name: Switch to dark mode
25+
26+
# Palette toggle for dark mode
27+
- media: "(prefers-color-scheme: dark)"
28+
primary: custom
29+
accent: custom
30+
scheme: slate
31+
toggle:
32+
icon: material/brightness-4
33+
name: Switch to system preference
34+
favicon: images/tf_full_color_primary_icon.svg
35+
36+
features:
37+
- content.code.copy
38+
- content.code.select
39+
- content.action.edit
40+
41+
plugins:
42+
- search
43+
- autorefs
44+
- mkdocstrings:
45+
default_handler: python
46+
handlers:
47+
python:
48+
options:
49+
show_source: true
50+
show_root_heading: true
51+
unwrap_annotated: true
52+
show_symbol_type_toc: true
53+
show_if_no_docstring: true
54+
show_symbol_type_heading: true
55+
merge_init_into_class: true
56+
show_signature_annotations: true
57+
separate_signature: true
58+
signature_crossrefs: true
59+
group_by_category: true
60+
show_category_heading: true
61+
show_submodules: false
62+
show_root_full_path: true
63+
docstring_section_style: "spacy"
64+
inherited_members: true
65+
summary: false
66+
filters:
67+
- "!^_"
68+
- "^__init__$"
69+
- "^__call__$"
70+
- "^__version__$"
71+
- "!^logger"
72+
- "!^test_"
73+
- "!_test$"
74+
extensions:
75+
- griffe_inherited_docstrings
76+
import:
77+
- https://docs.python.org/3/objects.inv
78+
- mkdocs-jupyter
79+
80+
extra_css:
81+
- stylesheets/extra.css
82+
83+
extra_javascript:
84+
- javascripts/mathjax.js
85+
- https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
86+
87+
markdown_extensions:
88+
- admonition
89+
- attr_list
90+
- def_list
91+
- tables
92+
- toc:
93+
permalink: true
94+
- pymdownx.highlight:
95+
anchor_linenums: true
96+
linenums: false
97+
line_spans: __span
98+
pygments_lang_class: true
99+
- pymdownx.inlinehilite
100+
- pymdownx.snippets
101+
- pymdownx.superfences
102+
- pymdownx.arithmatex:
103+
generic: true
104+
- pymdownx.critic
105+
- pymdownx.caret
106+
- pymdownx.keys
107+
- pymdownx.mark
108+
- pymdownx.tilde
109+
- md_in_html
110+
- pymdownx.emoji:
111+
emoji_index: !!python/name:material.extensions.emoji.twemoji
112+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
113+
watch:
114+
- tensorflow_transform
115+
116+
nav:
117+
- Preprocess and transform data: index.md
118+
- Guide:
119+
- Install: install.md
120+
- Get Started: get_started.ipynb
121+
- Using tf.Transform with TensorFlow 2.x: tf2_support.md
122+
- Common Transformations: common_transformations.md

0 commit comments

Comments
 (0)