Skip to content

Commit

Permalink
docs: switch completely to generated docs for scalar and aggregate fu…
Browse files Browse the repository at this point in the history
…nctions (#13161)

* Remove _new docs, update index, update docs build script to point to main .md files for aggregate & scalar function pages.

* update documentation
  • Loading branch information
Omega359 authored Oct 29, 2024
1 parent 444a673 commit 223bb02
Show file tree
Hide file tree
Showing 6 changed files with 5,125 additions and 5,300 deletions.
20 changes: 4 additions & 16 deletions dev/update_function_docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ SOURCE_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
cd "${SOURCE_DIR}/../" && pwd


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

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

echo "'$TARGET_FILE' successfully updated!"

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

echo "Inserting header"
Expand Down Expand Up @@ -107,13 +101,7 @@ update documentation for an individual UDF or the
dev/update_function_docs.sh file for updating surrounding text.
-->
# Scalar Functions (NEW)
Note: this documentation is in the process of being migrated to be [automatically created from the codebase].
Please see the [Scalar Functions (old)](aggregate_functions.md) page for
the rest of the documentation.
[automatically created from the codebase]: https://github.com/apache/datafusion/issues/12740
# Scalar Functions
EOF

Expand Down
Loading

0 comments on commit 223bb02

Please sign in to comment.