BioData Club Workshop: DIY Documentation with Read the Docs

You are invited to BioData Club’s next workshop: DIY Documentation with Read the Docs.

Good data, project, or software documentation makes your work more discoverable, transparent, and reusable. Read the Docs makes documentation easy by automating the building, versioning, and hosting of your docs, plus it’s free and open source!

In this hands-on BioData Club and OHSU Library workshop, instructors Eric Earl and Robin Champieux will introduce attendees to documentation best practices and guide them through the process of publishing a documentation website using Read the Docs and Markdown.

All OHSU community members and friends are welcome! No prior experience is required, but please register in advance – you can attend in person or via streaming video.  Attendees should bring a laptop and install the following software before the workshop:

1. Download & install Visual Studio Code
2. Sign up for a GitHub account
3. Sign up for a Read the Docs account using your GitHub account

DIY Documentation with Read the Docs
Friday, October 18
4:00 – 5:30
BICC 124 or live stream video
Register here: http://bit.ly/DIYdocs

About BioData Club:

BioData Club is an informal community at OHSU dedicated to promoting a fun and supportive culture of interdisciplinary co-learning in data science skills and open science principles. We welcome everyone at all skill levels who aim to better their skills in all things data. We want to replace statistics anxiety and code fear with inspiration and motivation to learn and share. BioData Club is a partnership of the OHSU Library and DMICE.

Leave a Reply