Create a documentation site for your Python API using Sphinx and GitHub Actions

Join us for our last event of 2022! 🤶

Thank you to the Microsoft Reactor for hosting the event and to Microsoft for sponsoring food and beverages.✨

📝 Agenda:
• 6:00pm Doors open, socialising, food and drinks offered by our sponsor
• 6:30pm Introduction, News, Workshop starts
• 8:15pm Workshop ends
• 8:30pm Fin

Title: Create a documentation site for your Python API using Sphinx and Github Actions

Description: You have built an awesome API, it’s time for some exposure! How do you create a documentation website and keep it up-to-date as your code evolves? This workshop will teach you how to write, generate, host and update your documentation automatically, so it becomes part of your software development lifecycle!

To build a documentation website from scratch, we will be using Sphinx – a powerful documentation generation tool that makes it easy to keep your API docs in sync with your code.

You will learn how to:

• generate documentation from your Python code
• customize the appearance of your website
• host your documentation on GitHub Pages
• automate the building and deployment of your documentation using Github Actions at the click of a button!

When you’re done, you’ll have a website that looks like this!

We recommend you bring your own laptop to be able to follow along. If you can’t bring one, no worries! We will pair you up with someone who does. 💻

#

Bio Aya Elsayed: Aya Elsayed (@ayaeelsayed) is a software engineer at Bloomberg. She’s a leader at the company's Python Guild, which aims to support Python engineers at Bloomberg to develop Python packages, and stay connected to the broader Python community. Aya has delivered a Sphinx workshop at PyCon UK 2022. Aya also co-leads a local Women in Tech community that supports women to grow their technical careers at the company. She also enjoys Pilates and trying out restaurants around London.

Bio Olga Matoula: Olga (@olgarithms_) is a senior software engineer at Bloomberg, where she develops chatbots and the framework to support them. She is also a co-chair of the Python Guild, an internal community of Python enthusiasts. Previously, she worked in different teams at Bloomberg and Microsoft, and had co-founded Code It Like a Girl, a social enterprise where she taught women how to code. Olga advocates for Open Source software and tries to contribute whenever she can. In her free time she enjoys practicing yoga and exploring London’s music and swing dancing scene.

🚨 Our meetups are governed by a Code of Conduct. Please take a few minutes to read it.