Using Sphinx to generate documentation for your codebase

Avneesh Chadha (~avneesh88)


22

Votes

Description:

Generating Documentation for your code is something that all developers hate doing (and managers love). Sphinx is a documentation tool that makes writing documentation for your code easy and painless (plus makes it look more professional).

The talk will include/touch upon the following :

  1. Setting up sphinx for your project.
  2. Generating docs for your project.
  3. Auto generating documentation for your functions as APIs.
  4. Automating the whole process for doc generation.
  5. Advanced features and best coding practices to make the most of Sphinx.

By the end of this talk people should be able to setup documentation for their codebase's, and automate it.

For a full list of features check out the sphinx documentation.

Prerequisites:

  1. Python Basics
  2. Experienced the pain of writing documentation on your own.

Content URLs:

https://pypi.python.org/pypi/Sphinx

Speaker Info:

Avneesh Chadha

I am polyglot developer working at Delhivery with about 4 years of experience. I try to have fun while making very high performance systems. Hate writing documentation and love unit test cases.

Apart from writing code, I like to spend my time finding simple ways to solve obscure problems (or just use Redis. Redis rocks. No seriously, it does!) and work on open source p2p protocols.

Speaker Links:

Github: https://github.com/avneesh91

Linkedin: https://www.linkedin.com/in/avneesh-chadha-0bb6b7aa/

Twitter: @av_neesh

Section: Infrastructure
Type: Talks
Target Audience: Beginner
Last Updated:

Hi, It would be nice if you add your slides too. It will help our team to review your proposal. Thanks

Rajat Saini (~rajataaron)

Login to add a new comment.