sustainableaviation / EcoPyLot

🍃🛩️ Prospective environmental and economic life cycle assessment of aircraft made blazing fast
http://ecopylot.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
2 stars 0 forks source link

Document Data Ingestion Pipeline #11

Closed michaelweinold closed 5 months ago

michaelweinold commented 5 months ago

The data ingestion pipeline must be documented (in the EcoPylot Sphinx documentation pages) before we start to implement

This documentation will then serve as the technical specification of the data ingestion pipeline.

[!NOTE]
This documentation is distinct from any API documentation (based on Python docstrings) that will be auto-generated from the data ingestion classes/functions. It should provide (technical) users a straightforward way to understand the data ingestion pipeline in the context of the entire project.

Ideally, this would include:

michaelweinold commented 5 months ago

@iamsiddhantsahu, as discussed please start from the docs/content/structure.md file.