cdp-backend icon indicating copy to clipboard operation
cdp-backend copied to clipboard

Clean up ingestion model docs -- specifically document attributes better

Open evamaxfield opened this issue 3 years ago • 1 comments

https://councildataproject.org/cdp-backend/cdp_backend.pipeline.html#cdp_backend.pipeline.ingestion_models.IngestionModel

  • each property should be documented
  • try to hide the from_json and from_dict methods
  • add example for every one
  • mark each model as required or optional

evamaxfield avatar Apr 29 '22 18:04 evamaxfield

Major doc overhaul, use:

"sphinx.ext.autosummary",
"sphinx_autosummary_accessors",
Database Models
---------------

.. currentmodule:: cdp_backend.database.models
.. autosummary::
    :toctree: generated/

    File
    Person

evamaxfield avatar May 01 '22 16:05 evamaxfield