Skip to content

README.md

Latest commit

 

History

History
45 lines (37 loc) · 2.13 KB

README.md

File metadata and controls

45 lines (37 loc) · 2.13 KB
Raw

Documentation

Uses sphinx-autoapi to generate API documentation from docstrings in the codebase.

Prerequisites

  • uv — installs the pinned Sphinx toolchain from pyproject.toml / uv.lock.
  • graphviz (dot on PATH, e.g. apt-get install graphviz) — source/conf.py renders the Central Hub AWS diagrams from ../deploy/providers/AWS/architecture/central_hub.py at build time and fails without it. ReadTheDocs installs it through build.apt_packages; for a text-only build on a host without graphviz, set FLIP_DOCS_SKIP_DIAGRAMS=1 (the two Central Hub deployment pages then warn about their missing images).
  • Network access to huggingface.co (and *.hf.co) — the user-guide GIFs are not tracked in git (FLIP#1236): source/conf.py fetches them from the public dataset aicentreflip/docs-gifs (the newest recording, or a release's own set on a release build — FLIP#1547) into the gitignored source/assets/generated/gifs/, verifying every file, and fails without it. A repeat build downloads only what changed. For a text-only build offline set FLIP_DOCS_SKIP_GIF_FETCH=1 (the user-guide pages then warn about their missing images). make test runs the fetcher/publisher/release-tagger suites.

To generate the documentation, run (from the repository root):

make -C docs clean
make -C docs docs

Or, from inside the docs/ directory:

cd docs
make clean
make docs