This is an automated email from the ASF dual-hosted git repository. srowen pushed a commit to branch branch-3.0 in repository https://gitbox.apache.org/repos/asf/spark.git
The following commit(s) were added to refs/heads/branch-3.0 by this push: new 99558f4 [SPARK-30832][DOCS] SQL function doc headers should link to anchors 99558f4 is described below commit 99558f4315b3b865471776d67d341b1d49826b2c Author: Nicholas Chammas <nicholas.cham...@gmail.com> AuthorDate: Mon Feb 17 19:19:28 2020 -0600 [SPARK-30832][DOCS] SQL function doc headers should link to anchors ### Why are the changes needed? In most of our docs, you can click on a heading to immediately get an anchor link to that specific section of the docs. This is very handy when you are reading the docs and want to share a link to a specific part. The SQL function docs are lacking this. This PR adds this convenience to the SQL function docs. Here's the impact on the generated HTML. Before this PR: ```html <h3 id="array_join">array_join</h3> ``` After this PR: ```html <h3 id="array_join"><a class="toclink" href="#array_join">array_join</a></h3> ``` ### Does this PR introduce any user-facing change? No. ### How was this patch tested? I built the docs manually and reviewed the results in my browser. Closes #27585 from nchammas/SPARK-30832-sql-doc-headers. Authored-by: Nicholas Chammas <nicholas.cham...@gmail.com> Signed-off-by: Sean Owen <sro...@gmail.com> (cherry picked from commit 4ed9b88996dc0e8f096157659d537d9dd8eaed47) Signed-off-by: Sean Owen <sro...@gmail.com> --- sql/mkdocs.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/sql/mkdocs.yml b/sql/mkdocs.yml index c34c891..8aad985e 100644 --- a/sql/mkdocs.yml +++ b/sql/mkdocs.yml @@ -17,3 +17,6 @@ site_name: Spark SQL, Built-in Functions theme: readthedocs pages: - 'Functions': 'index.md' +markdown_extensions: + - toc: + anchorlink: True --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org For additional commands, e-mail: commits-h...@spark.apache.org