daipom commented on code in PR #3100: URL: https://github.com/apache/arrow-adbc/pull/3100#discussion_r2189506298
########## CONTRIBUTING.md: ########## @@ -220,33 +220,58 @@ $ npm install -g @mermaid-js/mermaid-cli To build the HTML documentation: ```shell -$ pushd c/apidoc -$ doxygen -$ popd - -# Optionally: to also build the Python documentation -$ pushd python/adbc_driver_manager -$ pip install -e .[test] -$ popd - $ pushd docs $ make html ``` -The output can be found in `build/`. +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. Some documentations are maintained as [Mermaid][mermaid] diagrams, which must be rendered and checked in. This can be done as follows: ```shell -pushd docs -make -f mermaid.makefile -j all +$ pushd docs +$ make -f mermaid.makefile -j all # Check in the updated files ``` [mermaid]: https://mermaid.js.org/ [sphinx]: https://www.sphinx-doc.org/en/master/ +#### Building more complete documentation + +You can remove the warnings of `make html` and generate the Python API +reference as follows: + +```shell +$ mamba create -n adbc \ + --file ci/conda_env_docs.txt \ + --file ci/conda_env_cpp.txt \ + --file ci/conda_env_python.txt \ + --file ci/conda_env_java.txt +$ env ADBC_USE_ASAN=0 ADBC_USE_UBSAN=0 ./ci/scripts/cpp_build.sh $(pwd) $(pwd)/build Review Comment: I have checked the behavior. As you said, we don't need to run `cpp_build` for building documentation. We can run `docs_build.sh ` to build the cpp API reference, so we don't need to mention `cpp_build` in this section. Fixed: https://github.com/apache/arrow-adbc/compare/7f3d6d4927eb244223c38b8cd59270ef7c5fd3b2..9e6f584802fd6061502e2fe548de7145f84c8a02 (I noticed I forgot `mamba activate`, so I added it.) Thanks! -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: github-unsubscr...@arrow.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
