File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -1215,6 +1215,7 @@ tasks:
12151215 params :
12161216 env :
12171217 JDK : 17
1218+ DOCS_DEV : " 1"
12181219 pr_number : Unset
12191220 image : debian-docs
12201221 publish : true
Original file line number Diff line number Diff line change 328328# documentation.
329329#
330330
331+ # To enable the version switcher during a local build, set the
332+ # environment variable DOCS_DEV to "1".
333+ docs_dev = os .environ .get ("DOCS_DEV" , "0" )
334+ json_url = "/docs/_static/versions.json"
335+
336+ if docs_dev == "1" :
337+ json_url = "https://arrow.apache.org/docs/_static/versions.json"
338+ # json_url = "_static/versions.json"
339+
331340switcher_version = version
332341if ".dev" in version :
333342 switcher_version = "dev/"
365374 ],
366375 "show_version_warning_banner" : True ,
367376 "switcher" : {
368- "json_url" : "/docs/_static/versions.json" ,
377+ "json_url" : json_url ,
369378 "version_match" : switcher_version ,
370379 },
371380}
Original file line number Diff line number Diff line change @@ -87,6 +87,12 @@ These two steps are mandatory and must be executed in order.
8787 not sufficiently comprehensive. Portions of the Python API documentation
8888 will also not build without CUDA support having been built.
8989
90+ .. note ::
91+
92+ To enable the version switcher in a local documentation build, set the
93+ environment variable ``DOCS_DEV=1 `` before building, or run the build
94+ command with it inline, for example: ``DOCS_DEV=1 make html ``.
95+
9096After these steps are completed, the documentation is rendered in HTML
9197format in ``arrow/docs/_build/html ``. In particular, you can point your browser
9298at ``arrow/docs/_build/html/index.html `` to read the docs and review any changes
You can’t perform that action at this time.
0 commit comments