Debug Data
Talk Data:
{
"code": "D9CXMD",
"title": "Documenting Python Code",
"speakers": [
{
"code": "VGYMKY",
"name": "Christian Heitzmann",
"biography": "Christian Heitzmann, MSc ETH CSE, is the founder and owner of SimplexaCode AG, based in Lucerne, Switzerland. He is a certified software developer in Java and Python, holding teaching diplomas in both Computer Science and Mathematics, as well as a CAS in Machine Learning. With over 20 years of experience in software development and 12 years of teaching Java, Python, mathematics, and algorithms, Christian is also a regular contributor to IT journals, sharing his expertise in the field.",
"submissions": [],
"avatar_url": "https://pretalx.com/media/avatars/VGYMKY_mjyajQp.webp",
"answers": [
490245,
490246,
490247,
490248,
490249
],
"email": "konto.pretalx@simplexacode.ch",
"timezone": "UTC",
"locale": "de-formal",
"has_arrived": false,
"availabilities": [
{
"start": "2026-04-08T00:00:00+03:00",
"end": "2026-04-10T11:00:00+03:00",
"allDay": false
}
],
"internal_notes": ""
}
],
"submission_type": {
"id": 6673,
"name": {
"en": "Talk"
},
"default_duration": 25,
"deadline": null,
"requires_access_code": false
},
"track": {
"id": 6398,
"name": {
"en": "Python Day - Apr 8"
},
"description": {
"en": "Everything related to Python, IoT, Web dev, Web scraping"
},
"color": "#9c4b4b",
"position": 1,
"requires_access_code": false
},
"tags": [],
"state": "confirmed",
"abstract": "Good documentation doesn’t happen by accident. But it also doesn’t have to be painful. This talk shows how Python developers can integrate documentation naturally into their daily work. We’ll look at docstrings, turn them into readable docs with reStructuredText and Sphinx, and learn how few organizational measures, docs-as-code practices, and automation can help—or get in the way …",
"description": "Software documentation is usually treated as an afterthought, something we’ll “do later.” But later rarely comes. Yet every developer depends on documentation every day: in libraries, frameworks, and tools. So why do we so often skip it in our own projects?\r\n\r\nThis keynote takes a practical look at what good documentation means for Python code today. It covers the essential building blocks: docstrings, the Sphinx documentation generator, and the lightweight markup language reStructuredText. [A live demonstration will show how to create and publish technical documentation step by step, without magic and without pain.]\r\n\r\nWe will also touch on the broader context—how a docs-as-code approach fits naturally into modern development workflows, and what role automation can play. [Finally, we will ask whether AI can really help us document software, or whether it merely produces new forms of outdated or misleading text.]\r\nThe goal is simple: to make documentation a normal part of programming, not a burden that comes afterwards.",
"duration": 25,
"slot_count": 1,
"content_locale": "en",
"do_not_record": false,
"image": null,
"resources": [],
"slots": [],
"answers": [
490244
],
"pending_state": null,
"is_featured": false,
"notes": "I gave the advanced workshop \"What We Can Learn from Exemplary Python Documentation\" last year at PyCon Lithuania 2025. I'd be happy present my foundational talk \"Documenting Python Code\" this year at PyCon Lithania 2026. Usually it's the other way around ;-)\r\n\r\nMy proposed talk has been given several times (CH, IT, PL, SE, and GM as a keynote) and has always been very well received. If time allows (as did my keynote with 40 minutes), I could also include demos and some slides if AI can help with documentation. So 25 mins is possible, but 40 mins would allow more content and context.",
"internal_notes": null,
"invitation_token": "8LHVEHQLHB9GVWKYCXWXHHTFYWK3FVWT",
"access_code": null,
"review_code": "HCRMZYJNLNQYYWAJ8JQ7GRTPDTL3YB8X",
"anonymised_data": "{}",
"reviews": [],
"assigned_reviewers": [],
"is_anonymised": false,
"median_score": null,
"mean_score": null,
"created": "2026-01-09T07:07:40.832105+02:00",
"updated": "2026-01-09T07:07:40.832126+02:00",
"invitations": []
}Parsed Values:
{
"speakers": [
{
"code": "VGYMKY",
"name": "Christian Heitzmann",
"biography": "Christian Heitzmann, MSc ETH CSE, is the founder and owner of SimplexaCode AG, based in Lucerne, Switzerland. He is a certified software developer in Java and Python, holding teaching diplomas in both Computer Science and Mathematics, as well as a CAS in Machine Learning. With over 20 years of experience in software development and 12 years of teaching Java, Python, mathematics, and algorithms, Christian is also a regular contributor to IT journals, sharing his expertise in the field.",
"submissions": [],
"avatar_url": "https://pretalx.com/media/avatars/VGYMKY_mjyajQp.webp",
"answers": [
490245,
490246,
490247,
490248,
490249
],
"email": "konto.pretalx@simplexacode.ch",
"timezone": "UTC",
"locale": "de-formal",
"has_arrived": false,
"availabilities": [
{
"start": "2026-04-08T00:00:00+03:00",
"end": "2026-04-10T11:00:00+03:00",
"allDay": false
}
],
"internal_notes": ""
}
],
"track": {
"id": 6398,
"name": {
"en": "Python Day - Apr 8"
},
"description": {
"en": "Everything related to Python, IoT, Web dev, Web scraping"
},
"color": "#9c4b4b",
"position": 1,
"requires_access_code": false
},
"submissionType": {
"id": 6673,
"name": {
"en": "Talk"
},
"default_duration": 25,
"deadline": null,
"requires_access_code": false
}
}Documenting Python Code
Speaker
Christian Heitzmann
Christian Heitzmann, MSc ETH CSE, is the founder and owner of SimplexaCode AG, based in Lucerne, Switzerland. He is a certified software developer in Java and Python, holding teaching diplomas in both Computer Science and Mathematics, as well as a CAS in Machine Learning. With over 20 years of experience in software development and 12 years of teaching Java, Python, mathematics, and algorithms, Christian is also a regular contributor to IT journals, sharing his expertise in the field.
Abstract
Good documentation doesn’t happen by accident. But it also doesn’t have to be painful. This talk shows how Python developers can integrate documentation naturally into their daily work. We’ll look at docstrings, turn them into readable docs with reStructuredText and Sphinx, and learn how few organizational measures, docs-as-code practices, and automation can help—or get in the way …
Description
Software documentation is usually treated as an afterthought, something we’ll “do later.” But later rarely comes. Yet every developer depends on documentation every day: in libraries, frameworks, and tools. So why do we so often skip it in our own projects?
This keynote takes a practical look at what good documentation means for Python code today. It covers the essential building blocks: docstrings, the Sphinx documentation generator, and the lightweight markup language reStructuredText. [A live demonstration will show how to create and publish technical documentation step by step, without magic and without pain.]
We will also touch on the broader context—how a docs-as-code approach fits naturally into modern development workflows, and what role automation can play. [Finally, we will ask whether AI can really help us document software, or whether it merely produces new forms of outdated or misleading text.] The goal is simple: to make documentation a normal part of programming, not a burden that comes afterwards.