Skip to content

Commit 223bb02

Browse files
authored
docs: switch completely to generated docs for scalar and aggregate functions (#13161)
* Remove _new docs, update index, update docs build script to point to main .md files for aggregate & scalar function pages. * update documentation
1 parent 444a673 commit 223bb02

File tree

6 files changed

+5125
-5300
lines changed

6 files changed

+5125
-5300
lines changed

dev/update_function_docs.sh

+4-16
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ SOURCE_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
2424
cd "${SOURCE_DIR}/../" && pwd
2525

2626

27-
TARGET_FILE="docs/source/user-guide/sql/aggregate_functions_new.md"
27+
TARGET_FILE="docs/source/user-guide/sql/aggregate_functions.md"
2828
PRINT_AGGREGATE_FUNCTION_DOCS_COMMAND="cargo run --manifest-path datafusion/core/Cargo.toml --bin print_functions_docs -- aggregate"
2929

3030
echo "Inserting header"
@@ -56,13 +56,7 @@ update documentation for an individual UDF or the
5656
dev/update_function_docs.sh file for updating surrounding text.
5757
-->
5858
59-
# Aggregate Functions (NEW)
60-
61-
Note: this documentation is in the process of being migrated to be [automatically created from the codebase].
62-
Please see the [Aggregate Functions (old)](aggregate_functions.md) page for
63-
the rest of the documentation.
64-
65-
[automatically created from the codebase]: https://github.com/apache/datafusion/issues/12740
59+
# Aggregate Functions
6660
6761
Aggregate functions operate on a set of values to compute a single result.
6862
EOF
@@ -75,7 +69,7 @@ npx [email protected] --write "$TARGET_FILE"
7569

7670
echo "'$TARGET_FILE' successfully updated!"
7771

78-
TARGET_FILE="docs/source/user-guide/sql/scalar_functions_new.md"
72+
TARGET_FILE="docs/source/user-guide/sql/scalar_functions.md"
7973
PRINT_SCALAR_FUNCTION_DOCS_COMMAND="cargo run --manifest-path datafusion/core/Cargo.toml --bin print_functions_docs -- scalar"
8074

8175
echo "Inserting header"
@@ -107,13 +101,7 @@ update documentation for an individual UDF or the
107101
dev/update_function_docs.sh file for updating surrounding text.
108102
-->
109103
110-
# Scalar Functions (NEW)
111-
112-
Note: this documentation is in the process of being migrated to be [automatically created from the codebase].
113-
Please see the [Scalar Functions (old)](aggregate_functions.md) page for
114-
the rest of the documentation.
115-
116-
[automatically created from the codebase]: https://github.com/apache/datafusion/issues/12740
104+
# Scalar Functions
117105
118106
EOF
119107

0 commit comments

Comments
 (0)