https://github.com/mariatta/my_aquarium
Sample repo for documentation
https://github.com/mariatta/my_aquarium
Last synced: 2 months ago
JSON representation
Sample repo for documentation
- Host: GitHub
- URL: https://github.com/mariatta/my_aquarium
- Owner: Mariatta
- License: mit
- Created: 2021-05-02T22:18:40.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-05-02T22:19:24.000Z (about 4 years ago)
- Last Synced: 2025-03-24T09:47:06.114Z (3 months ago)
- Language: Python
- Size: 1.95 KB
- Stars: 0
- Watchers: 2
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: readme.rst
- License: license
Awesome Lists containing this project
README
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
.. _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