The FAIR Wizard user, administrator and developer guide, written in reStructuredText and built with Sphinx/Furo.
Use Python 3.12, matching GitHub and Read the Docs:
python3.12 -m venv .venv
source .venv/bin/activate
python -m pip install -r docs/requirements.txt
sphinx-build -b html -W --keep-going -n -D notfound_urls_prefix=/ docs docs/_build/htmlServe docs/_build/html locally to review it. The command overrides the 404 prefix only for the local root URL; Read the Docs uses its versioned canonical URL.
For automatic rebuilds, install docs/requirements.dev.txt and run make watch in docs. To validate print sources:
sphinx-build -b latex -W --keep-going -n docs docs/_build/latexA complete PDF build needs XeLaTeX and the FreeSans/FreeMono fonts (make latexpdf in docs). The Nunito heading fonts are bundled. LaTeX source generation alone does not validate the rendered PDF.
For a local build with Tectonic, generate the LaTeX sources as above, then run from the output directory:
tectonic --untrusted --keep-logs fairwizard.texRender the resulting PDF to page images and inspect tables, screenshots, code blocks and page breaks before release. Read the Docs still builds the PDF through its normal Sphinx/LaTeX workflow.
See CONTRIBUTING.md for simple RST conventions, RELEASING.md for the develop → preview → production cycle and WORKLOG.md for the current 5.0 work and remaining acceptance.
docs/requirements.direct.txt lists direct dependencies; docs/requirements.txt pins the tested environment. Update in an isolated Python 3.12 environment, regenerate the lock file and run both strict builds. Do not upgrade Docutils independently beyond the version supported by Sphinx.
Guide content is licensed under CC BY-SA. Bundled Nunito fonts retain their OFL license in docs/_static/fonts.
When changing toctree labels or navigation order, use sphinx-build -E -a -b html docs docs/_build/html to refresh the sidebar on every page.