Skip to content

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

License

Notifications You must be signed in to change notification settings

radeklat/sphinx-rest-cheatsheet

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Sphinx reStructuredText (reST) Cheatsheet

A compact cheat sheet for writing documentation strings in Python (and other languages) using reStructuredText markup. The documentation can be subsequently generated by Sphinx.

Download the cheatsheet PDF here.

About

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

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published