heterotopian / rest-sphinx-memo

reST and Sphinx Memo

Home Page:http://rest-sphinx-memo.readthedocs.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Introduction

This Memo is a fork of a previous version of Cristoph Reller reST Memo it has been modified and largely extended on the Sphinx part, and Cristoph Reller also has also modified his memo.

Sphinx itself is very well documented, but is very large and cover many aspects, all of them not for daily use. And the Documentation of Rest, while being very rigorous is not of an easy access, at least at my own taste. I use to spend a lot of time to clarify eve tiny aspect, as the documentation is often scattered in many locations.

Moreover Sphinx seems first to be an extension of Rest, but it is not always true and there are some difference of aims, and incompatibilities, between Sphinx and Rest constructs.

This Memo give the constructs that I use the most often, and give cross-references to the manuals for details.

About

reST and Sphinx Memo

http://rest-sphinx-memo.readthedocs.org


Languages

Language:Python 64.6%Language:Makefile 35.0%Language:HTML 0.4%Language:CSS 0.1%