search

mozilla / active-data-recipes

A repository of various activedata queries and recipes
Mozilla Public License 2.0
8 stars 24 forks source link

Create a readthedocs page for active-data-recipes #14

Closed ahal closed 6 years ago

ahal commented 6 years ago

I've been stuffing most of the recipe documentation into the README.md file, but this doesn't scale well and it's easy to forget to add new recipes.

We should create a readthedocs site and set things up such that new recipes automatically get added. We can use sphinx-autodoc to pull the necessary info out of their docstrings.

ahal commented 6 years ago

This was fixed by 2bcfa8ab3dacf8b4033e5c9ea7ac0d55a1f94fc2 (and follow-up commits around docstrings). There is also now a doclint that will fail if any recipes are missing from the docs.