Skip to content

Your Code Should Document Itself!

A MacAD.UK 2018 Conference Presentation by Bryson Tyrell

Bryson Tyrell MacAD speakerOne of the great foils of writing code is you should probably document it in a way that makes it easier for others to use. However, trying to maintain a set of documentation apart from your codebase is tedious and very manual and prone to mistakes.

  • Well, what if I told you that your documentation can live inside your repository and the code itself?
  • What if you don’t have to bounce back and forth between different locations to record changes you have been making?
  • What if the source for your documentation lived within your repository and within your Python files ready to be exported in a variety of formats for distribution?

In this session, we’re going to talk about writing Python docstrings with reStructuredText markup, using the Sphinx toolset for generating documentation from those files, and leveraging Read the Docs (readthedocs.org) with GitHub for doing it all automatically every time you make a commit!

Who should attend?

If you code and want to find out how to document effortlessly, this one’s for you.

Want to attend?

Only delegates with a valid pass will be admitted to the event, but those with a pass don’t need to reserve places at presentations.

Book a conference pass here.

Leave a Comment

You can use these HTML tags:
<a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <s> <strike> <strong>