This is an automated email from the ASF dual-hosted git repository.
lidavidm pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-adbc.git
The following commit(s) were added to refs/heads/main by this push:
new e8a79b7ba docs: describe how to use sphinx-autobuild (#4383)
e8a79b7ba is described below
commit e8a79b7bac961b28be53442a75e6d3fac97247dd
Author: David Li <[email protected]>
AuthorDate: Thu Jun 11 14:30:23 2026 -0700
docs: describe how to use sphinx-autobuild (#4383)
Closes #4246.
---
CONTRIBUTING.md | 15 +++++++++++++--
1 file changed, 13 insertions(+), 2 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index bc4ce23f1..4e4bf6a0e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -217,7 +217,7 @@ $ mamba activate adbc
$ npm install -g @mermaid-js/mermaid-cli
```
-To build the HTML documentation:
+To build the HTML documentation once:
```shell
$ pushd docs
@@ -226,7 +226,18 @@ $ make html
The output can be found in `build/`. This does not generate API references
and results in some warnings, but it is not a problem if you're not working
-with the API documentation.
+with the API documentation. If you do wish to build the full documentation,
+use the script `ci/scripts/docs_build.sh`.
+
+Usually, you will want to make and preview edits in real-time. Use
+[`sphinx-autobuild`](https://github.com/sphinx-doc/sphinx-autobuild) (which is
+installed as part of the Conda environment above), which will spawn an HTTP
+server on localhost and rebuild the documentation whenever you make changes:
+
+```shell
+$ pushd docs
+$ sphinx-autobuild source build
+```
Some documentations are maintained as [Mermaid][mermaid] diagrams, which must
be rendered and checked in. This can be done as follows:
