https://github.com/marczz/rest-sphinx-memo

reST and Sphinx Memo
https://github.com/marczz/rest-sphinx-memo

Last synced: 12 days ago
JSON representation

reST and Sphinx Memo

• Host: GitHub
• URL: https://github.com/marczz/rest-sphinx-memo
• Owner: marczz
• Created: 2012-02-16T10:56:42.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2021-08-27T14:14:39.000Z (about 3 years ago)
• Last Synced: 2024-08-01T20:38:20.345Z (3 months ago)
• Language: Python
• Homepage: http://rest-sphinx-memo.readthedocs.org
• Size: 238 KB
• Stars: 43
• Watchers: 1
• Forks: 53
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

        
************

Introduction

************

.. sidebar:: License

   .. figure:: https://i.creativecommons.org/l/by-nc/4.0/88x31.png

      :target: http://creativecommons.org/licenses/by-nc-sa/4.0/

      :alt: Creative Commons License: NonCommercial-ShareAlike

      ..

      | `Rest and Sphinx Memo by Marc Zonzon `_

      | is licensed under a `Creative Commons Attribution-NonCommercial 4.0 International License `__.

      | Source `in GitHub `_

This Memo aim to be a quick reference to ReST and Sphinx syntax, it tries to give a

short reference to the most usual [*]_ constructs and gives cross-references to the

manuals for details.

Sphinx  is very well documented, but is very large and cover

many aspects, all of them  not for daily use.

The ReST documentation is very rigorous and copious but not of easy access,

as the documentation is scattered in many locations.

Sphinx extend Rest, but introduces incompatibilities with pure ReST constructs.

..  [*] *usual* ranking is done only from what I use!