amosproj / amos2023ws06-sales-lead-qualifier

MIT License
4 stars 0 forks source link

Automatic generation of documentation (pydoc) #217

Closed Tims777 closed 9 months ago

Tims777 commented 10 months ago

Our stages are well-documented by now but mostly within the Python files, where it is easy to keep track of changes. However, for SumUp it mightbe tedious to look up individual source code files, so we want to compile a "human-readable" document (probably Markdown or HTML) from that.

The document should be easily accessible to SumUp so we can either put it with the rest of our documentation or maybe make the document generation part of the build process instead.

Acceptance Criteria