Incorporating Managed Information Repositories to Generate On-Demand Documentation
summary
A working system is shown that pulls a project list, syncs issue-tracker items and wiki pages from FogBugz, and renders a single up-to-date documentation artifact. The implementation uses Flask and Python with a two-route demo (projects and per-project docs), embeds docstrings and tests so builds fail if docs are stale, and produces Word/HTML/PDF via Pandoc while automating sync and generation with Jenkins.
AI-written summary · about
chapters (4)
- 0:00Start
- 8:26Maintain a single source for generating artifacts for information consumption.
- 9:21Keep the information where you are working.
- 11:11Requirements are Tasks
related talks
17mIf It’s Not Documented, Your Project Doesn’t Exist
01h 06mDocument your code
02h 59mDocumenting your code from docstrings to automated builds
18mThanks, I Made It with Quartodoc
30mMaking Your Documentation Interactive with PyScript
02h 28mWriting Documentation with Sphinx and reStructuredText
31mA reliable developmentrelease workflow for open source Python libraries
54mLightning Talks Wednesday