Building Documentation

Arelle’s documentation is built using Sphinx and published to Read the Docs.

Build Locally

  1. Install documentation dependencies.

    pip install -r requirements-docs.txt
    
  2. Navigate to the docs directory.

    cd docs
    
  3. Build HTML documentation

    • Linux or macOS

      # build
      make html
      # or auto rebuild on file changes (useful when working on documentation)
      make livehtml
      
    • Windows

      # build
      .\make.bat html
      # or auto rebuild on file changes (useful when working on documentation)
      .\make.bat livehtml
      
  4. Open documentation: