My talk “Documenting Python Code” has been accepted for the Swiss Python Summit on September 21, 2023.
Software documentation is important! So far, you’ve benefited from well-documented Python libraries, so it’s only natural to document your own code in order to keep your software usable and maintainable.
However, the first step is often the most difficult. Therefore, this talk will provide an introduction to documenting Python code effectively. You will learn about the basic concepts of Docstrings, the Sphinx documentation generator, and the standard lightweight markup language reStructuredText. You will also learn about the benefits of a docs-as-code approach in general, and find an answer to the question of whether Python can also be documented using other markup languages.
The summit will take place on the beautiful campus of the OST Eastern Switzerland University of Applied Sciences in Rapperswil SG, Switzerland. As long as the program is not published yet (now you know at least one talk that will definitely be part of it), you can register for an early bird ticket with a 40 % discount. But I can’t tell you how long this will last; it will probably only be a matter of a few days left.
All talks will be in English. You can find all the information here: www.python-summit.ch
I’m looking forward to meeting you there.