Skip to content

Commit 9e60817

Browse files
PySpark API (using mkdocs-material's tags)
1 parent 0358199 commit 9e60817

File tree

6 files changed

+37
-8
lines changed

6 files changed

+37
-8
lines changed

docs/PythonFunction.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
tags:
3+
- Scala
4+
---
5+
16
# PythonFunction
27

38
`PythonFunction` is an [abstraction](#contract) of the [metadata](#implementations) of a [Python function](sql/PythonUDF.md#func) of a [PythonUDF](sql/PythonUDF.md).

docs/pyspark/sql/SparkSession.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
tags:
3+
- Python
4+
---
5+
16
# SparkSession
27

38
`SparkSession` is a Python class in [pyspark.sql.session](session.md) module.

docs/python-api.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Python API
2+
3+
[TAGS]

docs/scala-api.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Scala API
2+
3+
[TAGS]

docs/tags.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# APIs
2+
3+
[TAGS]

mkdocs.yml

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ theme:
1515
icon:
1616
logo: material/book-open-page-variant
1717
repo: fontawesome/brands/github
18+
tag:
19+
python: fontawesome/brands/python
20+
scala: simple/scala
1821
features:
1922
# https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#adding-annotations
2023
- content.code.annotate
@@ -82,13 +85,15 @@ plugins:
8285
# https://squidfunk.github.io/mkdocs-material/reference/#built-in-meta-plugin
8386
- meta
8487
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/
85-
# - tags:
86-
# enabled: !ENV [CI, false]
87-
# tags_extra_files:
88-
# developer-api.md:
89-
# - DeveloperApi
90-
# https://github.com/squidfunk/mkdocs-material/issues/5241
91-
# # https://squidfunk.github.io/mkdocs-material/reference/#built-in-typeset-plugin
88+
- tags:
89+
# enabled: !ENV [CI, false]
90+
tags_file: tags.md
91+
tags_extra_files:
92+
python-api.md:
93+
- python
94+
scala-api.md:
95+
- scala
96+
# https://squidfunk.github.io/mkdocs-material/reference/#built-in-typeset-plugin
9297
- typeset
9398

9499
extra:
@@ -140,7 +145,8 @@ extra:
140145
jira: https://issues.apache.org/jira/browse
141146
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#tag-icons-and-identifiers
142147
tags:
143-
DeveloperApi: developerapi
148+
Python: python
149+
Scala: scala
144150

145151
nav:
146152
- index.md
@@ -153,6 +159,10 @@ nav:
153159
- ... | pandas-on-spark/**.md
154160
- ... | pandas-udafs/**.md
155161
- ... | pandas-udfs/**.md
162+
- PySpark API:
163+
- tags.md
164+
- python-api.md
165+
- scala-api.md
156166
- ... | connect/**.md
157167
- ... | ml/**.md
158168
- ... | sql/**.md

0 commit comments

Comments
 (0)