GitXplorerGitXplorer
M

my_aquarium

public
0 stars
8 forks
0 issues

Commits

List of commits on branch main.
Unverified
73c34e755fd87ae5f1e6c3459def06d0fdda054c

Setting up a sample repo for documentation.

MMariatta committed 3 years ago

README

The README file for this repository.

This is a sample repo

This repo is to be used as an example for Mariatta's PyCon US 2021 tutorial: Writing Documentation with Sphinx and reStructuredText_

It has a made-up Python module called my_aquarium. This module will be used in the tutorial to show how to add the Sphinx documentation project to it.

Python version compatibility: 3.6+ and up, because of f-strings.

.. raw:: html

<iframe src="https://github.com/sponsors/Mariatta/card" title="Sponsor Mariatta" height="225" width="600" style="border: 0;"></iframe>

.. _Mariatta: https://github.com/mariatta .. _PyCon US 2021: https://us.pycon.org/2021 .. _Writing Documentation with Sphinx and reStructuredText: https://us.pycon.org/2021/schedule/presentation/23