Skip to content

Remove old static documentation function pages (Aggregate/Scalar) #12741

Closed
@alamb

Description

@alamb

Part of #12740

Is your feature request related to a problem or challenge?

@Omega359 added the infrastructure to automatically create documentation from code in #12668

For a while this will result in a transition period where we have two copies of most function documentation:

  1. A "static" one (e.g. https://datafusion.apache.org/user-guide/sql/scalar_functions.html)
  2. A "auto generated" one (e.g. TODO WHEN MERGED)

Describe the solution you'd like

Once all the documentation for functions has been migrated to the new auto generated pages, we should remove the static pages

Describe alternatives you've considered

Basically this means for the scalar, window and aggregate functions:

  1. Delete the static file docs/source/user-guide/sql/scalar_functions.md
  2. Rename the _new files like docs/source/user-guide/sql/scalar_functions_new.md to docs/source/user-guide/sql/scalar_functions.md
  3. Update the index page docs/source/user-guide/sql/index.rst to remove the _new entries
  4. Update the script dev/update_function_docs.sh so it writes to the scalar_functions.md file

Additional context

We need to complete porting all documentation first

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions