Welcome to Git Workshop Part 3 on Documentation!

Here are the basic git concepts that we covered in the first workshop, that will be needed in today’s workshop. Feel free to take a look, in case you forgot something.

Git Basics

• Creating a Repository
  • Create Project on GitLab
  • Use Project Template
  • Sync Local and Remote Repository
• Git Workflow
  • Idea
  • Instructions

Documentation Basics

Today we will learn how to write documentation and publish it on the web. At first we will start with the basics of documentation.

• Documentation 101
  • Readme
• RestructuredText
  • Example
  • Idea
  • Properties

Deploy Documentation

The second session will be about publishing your documentation on the web.

• Sphinx
  • Why shall we use it?
  • Quick Start
  • Example
• Continuous Deployment
  • Idea
  • Purpose
  • Webhook
• Read the Docs
  • Setup Read the Docs
  • Build Documentation
  • Add Webhook

Docstring

And the third session will be about documenting more detailed code interfaces.

• Doc-Strings
  • Types of Docstrings
  • Detailed Docstring
  • Autodoc

Exercises

Here you can find some tasks to practise the ideas introduced above.

• Task 0: Create a new repository
• Task 1: Readme
• Task 2: Creating Sphinx Documentation
  • Setup Sphinx
  • Landing Page
• Task 3: Read the Docs
• Task 4: Docstrings

Indices and tables

• Index

• Search Page