DataFusion Distributed Documentation

This directory contains the documentation for DataFusion Distributed, built using Sphinx.

Building the Documentation

Prerequisites

Install the required dependencies:

pip install -r requirements.txt

Build HTML Documentation

make html

The generated documentation will be available in build/html/index.html.

Clean Build Files

make clean

Documentation Structure

• source/ - Documentation source files (reStructuredText and Markdown)
  • user-guide/ - User-facing documentation
  • architecture/ - Architecture documentation
  • contributor-guide/ - Contributor documentation
  • _static/ - Static files (images, CSS, etc.)
  • _templates/ - Custom templates

Contributing

When adding new documentation:

1. Create new .md or .rst files in the appropriate subdirectory
2. Add references to new files in the relevant index.rst or index.md
3. Build and preview your changes locally
4. Ensure all links and references work correctly