Name: Virtual Meetup: Building Docs in Python
Start: 2020-05-07T18:00:00-04:00
End: 2020-05-07T19:30:00-04:00

For PyCon 2020, Mason Egger gave a talk describing a procedure for writing documentation for our projects that goes against the norm of writing an entire application and then creating all of the coordinating documentation. In his talk, he proposes a process of feature development and documentation development performed at the same time and shares tools that can be used to get the job done.

Join us for an evening of discussing this talk and the tools mentioned by Mason. If you have time, please start with the primary talk video before diving into the tooling overviews (all below). I will start the meeting with a brief synopsis of the presentation for those who are unable to watch the video but would still like to attend. After that, we'll play a bit of choose your own adventure as we chat about our successes and failures with docs, how tools like Sphinx can transform our workflow, and any other topics that tie back to this content.

We will be using Jitsi for video conferencing on this event. Jitsi is an open source project and meet.jit.si is a free offering of the service.

Primary Talk:
Building Docs like Code - https://www.youtube.com/watch?v=4SwdVMKhbn4

Docs for Tooling:
Sphinx - https://www.sphinx-doc.org/en/master/
MkDocs - https://www.mkdocs.org/
Cookiecutter - https://cookiecutter.readthedocs.io/en/latest/

Talks Introducing Tooling:
Practical Sphinx - https://www.youtube.com/watch?v=0ROZRNZkPS8
MkDocs: Documenting Projects with Markdown - https://www.youtube.com/watch?v=pzoOQg6BNG4
Kickstarting Projects with Cookiecutter - https://www.youtube.com/watch?v=nExL0SgKsDY

Andrew Jones

Tampa Bay Python

Technology

Python Web Development

Python

Software Development

Artificial Intelligence Applications

Data Science using Python

Virtual Meetup: Building Docs in Python

Online event

Share

Tampa Bay Python

Virtual Meetup: Building Docs in Python

Tampa Bay Python

Details

Members are also interested in