https://github.com/radeklat/sphinx-rest-cheatsheet

A compact cheat sheet for writing documentation string for Sphinx, with focus on Python.
https://github.com/radeklat/sphinx-rest-cheatsheet

cheatsheet docstring-documentation docstrings documentation python rest restructuredtext sphinx

Last synced: 3 months ago
JSON representation

A compact cheat sheet for writing documentation string for Sphinx, with focus on Python.

• Host: GitHub
• URL: https://github.com/radeklat/sphinx-rest-cheatsheet
• Owner: radeklat
• License: gpl-3.0
• Created: 2016-09-25T09:06:11.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-06-15T14:57:00.000Z (almost 8 years ago)
• Last Synced: 2025-01-02T05:23:13.685Z (over 1 year ago)
• Topics: cheatsheet, docstring-documentation, docstrings, documentation, python, rest, restructuredtext, sphinx
• Size: 435 KB
• Stars: 17
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Sphinx reStructuredText (reST) Cheatsheet

A compact cheat sheet for writing documentation strings in Python (and other languages) using [reStructuredText markup](http://www.sphinx-doc.org/en/stable/rest.html). The documentation can be subsequently generated by [Sphinx](http://www.sphinx-doc.org).

**Download the cheatsheet PDF [here](https://github.com/rlat/sphinx-rest-cheatsheet/raw/master/rest_sphinx_cheatsheet.pdf).**