Hamilton helps data scientists and engineers define testable, modular, self-documenting dataflows, that encode lineage and metadata. Runs and scales everywhere python does.
BSD-3-CLAUSE-CLEAR License
Instructions for managing documentation on read the docs.
To build locally, you need to run the following -- make sure you're in the root of the repo:
pip install .[docs]
and then one of the following to build and view the documents:
sphinx-build -b dirhtml -W -E -T -a docs /tmp/mydocs
python -m http.server --directory /tmp/mydocs
or for auto rebuilding do:
sphinx-autobuild -b dirhtml -W -E -T --watch hamilton/ -a docs /tmp/mydocs
Then it'll be running on port 8000.
Note: readthedocs builds will fail if there are ANY WARNINGs in the build. So make sure to check the build log for any warnings, and fix them, else you'll waste time debugging readthedocs build failures.
We use both! The general breakdown of when to use which is: