Skip to content

Intro text outdated: refers to old order or episodes #340

@mmesiti

Description

@mmesiti

This is outdated:

We will discuss best practices, and briefly discuss the available tools.

Then we will discuss the form of documentation which is the most immediate to write: in-code comments, and docstrings.

We will step up our game and discuss what makes a good README. For many projects, a curated README is enough.

We will then learn how to build documentation with the documentation generator Sphinx and how to deploy it to GitHub Pages. The approach that we will learn will be transferable to GitLab Pages and Bitbucket Pages.

The order has been changed, and the best practices/available tools have been moved to the back

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions