Speaker
Mason Egger
Materials
Note
- Types of docs
- Long form documentation: User Guides, Getting Started, FAQs, etc.
- Functional documentation: RESTful APIs, SDKs, man pages
- Tools
- Static site generators
- Source code based documentation generators
- e.g., pydoc
- System documentation generator
- Mkdocs
- Markdown based documentation
- yaml based config file
- Python based → Easy to extend
- Extension
- UML
- Sphinx
- reStructured Text based documentation with support for Markdown
- Most common tool for creating SDK from in-code documentatoin
- Documentation Testing