Wrangler Docs¶
A centralized repository for storing documentation for 4DN/CGAP data wranglers. Pushes to master will automatically trigger a docs build. The badge above indicates the latest build status. Sphinx is very reluctant to fail so it is unlikely to do so even in the presence of many formatting errors. Documentation should be written in rst
format. Here is a helpful CheatSheet on how to use the format. This document should ideally be identical to docs/source/index.rst
except that in index.rst
you will want to use the toctree
directive to specify the documentation hierarchy (see here).