tree: d104f764324d5b98001d3f5fafc26e0e9f02df77 [path history] [tgz]
  1. source/
  2. .gitignore
  3. README.md
  4. requirements.txt
docs/README.md

Building nanoarrow documentation

Building the nanoarrow documentation requires Python, R, Doxygen, and pandoc. In addition, several Python and R packages are required. You can install the Python dependencies using pip install -r requirements.txt in this directory; you can install the R dependencies using R -e 'install.packages("pkgdown").

The ci/scripts/build-docs.sh script (or the docker compose run --rm docs compose service) can be used to run all steps at once, after which sphinx-build source _build/html can be used to iterate on changes.

git clone https://github.com/apache/arrow-nanoarrow.git

# Usually easiest to start with one of the docs build scripts
docker compose run --rm docs
# or install prerequisites and run
ci/scripts/build-docs.sh

# Iterate on Sphinx documentation
cd docs
sphinx-build source _build/html