Cheuk Ting Ho
Developer advocate / Data Scientist - support open-source and building the community.
Online Absolute Beginner Python Tutorials
Every Sunday 2pm (UK time/ BST)
by Cheuk Ting Ho
Get this slide deck:
slides.com/cheukting_ho/python-docs
Beginner topics:
Python objects - int, float, str, list, dict, bool
Control flows - if-else, for loop, while loop
Functions, modeuls, classes and decorators
strings operations and regex with re
Testing:
pytest with fixtures and mock
property-based testing
python linters & auto-formatters
TDD
Intermedite topics:
Iterators, generators, async
Use # as comments, which acts as notes
But that's not good enough
Docstrings is embedded in the Python object and can be called as reference
- Google style
- Numpy style
https://realpython.com/documenting-python-code/#docstring-formats
Sphinx is a documentation generator written and used by the Python community. It is written in Python, and also used in other environments.
The good thing about using Sphinx - it turns your docstrings into a website!
Documentation site generation flow
Docstrings
Autodoc
pages in rst
html pages
Deploy
read the doc/ gh pages
Sunday 2pm (UK time/ BST)
There are also Mid Meet Py every Wednesday 1pm
By Cheuk Ting Ho
Developer advocate / Data Scientist - support open-source and building the community.