Objective
To learn how to write documentation for your codebases. Documentation is the key for communication and developers are the best person to start writing it. Projects can succeed or fail because of their documentation.
Description
In the workshop the people will be introduced to reStructuredText & sphinx. Starting from quick-start of a project to document organization, code and topic cross-referencing, indexing. We will also go through running tests from your documentation, initial ideas on themes and deployment in readthedocs.
One can think about this workshop as the followup from last year's talk.
Quick summary of the workshop
- Introduction to reStructuredText
- Introduction to sphinx
- A project structure with docs
- hands-on tutorial with sphinx
- Integration with readthedocs
Requirements
- python-sphinx
- An open mind to learn
Speaker bio
Kushal Das is upstream author of various Python applications. He is a Fedora Ambassador and also member of Python Software Foundation.
He is a regular speaker in different technical conferences and also does Python workshops in various events & engineering colleges.
He also wrote a beginner Python book called Python for you and me which is targeted to the students for fast paced learning and available freely online .
1
▼
Kushal, can you please change the section to workshop. That is the only way for now to mark something as a workshop.
Also, please turn your book title into a link and add links to your previous talks, that'll help others to understand your profile better.
1
▼
I am making changes to the proposal, thanks for the suggestions.
1
▼
Looking forward to this.
1
▼
If this is indeed "the followup from last year's talk." then please provide a link to the talk along side. Additionally, it would be good to write down explicitly the take-away from your workshop. This helps participants gauge if they had a successful workshop from which they learnt useful things.