Thomas Cokelaer's blog
Notes on Data Analysis, Computer Science, Python, Biology, …
Skip to content
  • Home
  • About this blog’s contents
  • Gallery
  • Jump to main portal
← Python ressources
What is a Python descriptor →

Sphinx and ReST syntax for Python documentation

Posted on March 22, 2011 by Thomas Cokelaer

Sphinx is a tool that ease the creation of documentation for computer languages such as Python but also C/C++. The Sphinx syntax is an extension to the ReST (or RST) syntax. The drawback is that you need to learn another language, but it remains quite simple and its advantage is that it remains human readable (useful for the docstrings in Python!).

I put a rough guide to the Sphinx and ReST syntax. It can be found on my main page Sphinx and ReST guide. I consider it as a draft, but it should already be of interest for some of you.

Please follow and like us:
error
fb-share-icon
Tweet
fb-share-icon
This entry was posted in Python and tagged python, rest, sphinx. Bookmark the permalink.
← Python ressources
What is a Python descriptor →

Leave a Reply Cancel reply

Your email address will not be published.

  • Follow me

  • Recent Posts

    • How to select genomic region using samtools
    • Nice vscode extensions
    • conda list command broken (unknown variable: python_implementation)
    • ipython autocompletion does not work
    • Setup ssh server on Fedora Linux platform
  • calendar

    March 2011
    M T W T F S S
     123456
    78910111213
    14151617181920
    21222324252627
    28293031  
        Apr »
  • Recent Comments

    • Peter D. on How to use subprocess with PIPEs
    • Ali Zhang on About matplotlib colormap and how to get RGB values of the map
    • cloud on gimp: how to make a transparent background
    • Stan Blum on gimp: how to make a transparent background
    • 1125 on pytest-cov collects no data on Travis
  • Archives

  • Categories

    • amusement
    • bioinformatics
    • biology
    • Computer Science
    • Data analysis
    • Internet related
    • Life Science
    • Linux
    • Notes
    • Others
    • photos
    • Python
    • R
    • raspberryPi
    • Software development
    • Uncategorized
    • wordpress
  • Meta

    • Log in
    • Entries feed
    • Comments feed
    • WordPress.org
  • Media RSS

    • MediaRSS Icon Media RSS
Thomas Cokelaer's blog
Proudly powered by WordPress.
RSS
Follow by Email
Facebook
fb-share-icon
Twitter
Visit Us
Follow Me
Tweet