473,327 Members | 1,952 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,327 software developers and data experts.

reStructuredText Cheat Sheet

I whipped together a cheat sheet for reStructuredText:
1 page for syntax, and a 1 page reference for directives
and roles. Please take a look:
<http://docutils.sf.net/docs/rst/cheatsheet.txt> (not
meant to be converted to HTML; use the source text as-is).
Feedback is welcome.

--
David Goodger <http://python.net/~goodger>

Jul 18 '05 #1
2 3500
David Goodger wrote:
I whipped together a cheat sheet for reStructuredText:
1 page for syntax, and a 1 page reference for directives
and roles. Please take a look:
<http://docutils.sf.net/docs/rst/cheatsheet.txt> (not
meant to be converted to HTML; use the source text as-is).
Feedback is welcome.


hi,
to be honest i find it a bit confusing...
i did not really look into ReST's syntax yet but i assumed it partly as
a wiki style "markup" alternative and thought it was (also) meant as
that (apart from surely more py stuff).

maybe it is just me or that i am no native english speaker but i did not
really understand the syntax on the sheet or what some things are for.
an example would be the 2nd table about explicit markup, do the 2 dots
".." belong to the syntax or not?
i need to look more into the docutils docs, maybe it gets clearer then.

it is a good thing to have though
chris

Jul 18 '05 #2
chris wrote:
to be honest i find it a bit confusing...


It's a quick reference card to for authors who already know the syntax
but need reminders. It's not meant as something to learn from.
That's what the "See <http://docutils.sf.net/rst.html> for full info"
is for. You'll find tutorial and user documentation there.

-- David Goodger
Jul 18 '05 #3

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

5
by: Rajiv | last post by:
HI ALL, actually , i m working in a company having large number of employee , i have two userid and password . on id is from admin group(id given to me by technology manager) of the server and...
4
by: Jim | last post by:
Hi, I'm using reStructuredText as a format for some group documentation, and often my co-workers take notes during meetings in Word's outline mode. Does anyone already have a python script that...
2
by: darrel | last post by:
I'm struggling to keep track of all the ways to format a match value. Can anyone recommend a decent overview or cheat-sheet? Here's the particular one I'm stuck on: I want to match any 'page'...
7
by: Mark Huebner | last post by:
Does anyone know if there is a laminated quick reference or cheat sheet available for the C# language? If so, who makes it and where can I get one? Short coding samples with explanatory comments...
1
by: Max Kubierschky | last post by:
Hi, I try to use epydoc with reStructuredText. It works fine, my only problem is that I couldn't figure out the syntax for links to other methods or classes. Any hints? Max P.S: Where is...
4
ronverdonk
by: ronverdonk | last post by:
Maybe you alle know this, but for all beginners: there is a website that has excellent so-called "cheat sheets". These are short, 1 page overviews of the most important parts of a product. They...
22
by: Riccardo T. | last post by:
I wrote a little cheat sheet for this wonderful language, but because of my still little experience with it, I would like to have a feedback Could you have a look at it and tell me what do you...
1
by: Infinity77 | last post by:
Hi All, I apologize in advance if my question sounds dumb. I googled back and forth but my google-fu today is not working very well... I have seen the new style Python html documentation, which...
2
hemantbasva
by: hemantbasva | last post by:
Note We need to have a template on server for generating report in multiple sheet as we do not had msoffice on server moreover this require a batch job to delete excel file created by the...
0
by: DolphinDB | last post by:
Tired of spending countless mintues downsampling your data? Look no further! In this article, you’ll learn how to efficiently downsample 6.48 billion high-frequency records to 61 million...
0
by: ryjfgjl | last post by:
ExcelToDatabase: batch import excel into database automatically...
0
isladogs
by: isladogs | last post by:
The next Access Europe meeting will be on Wednesday 6 Mar 2024 starting at 18:00 UK time (6PM UTC) and finishing at about 19:15 (7.15PM). In this month's session, we are pleased to welcome back...
0
by: jfyes | last post by:
As a hardware engineer, after seeing that CEIWEI recently released a new tool for Modbus RTU Over TCP/UDP filtering and monitoring, I actively went to its official website to take a look. It turned...
1
by: CloudSolutions | last post by:
Introduction: For many beginners and individual users, requiring a credit card and email registration may pose a barrier when starting to use cloud servers. However, some cloud server providers now...
1
by: Defcon1945 | last post by:
I'm trying to learn Python using Pycharm but import shutil doesn't work
1
by: Shællîpôpï 09 | last post by:
If u are using a keypad phone, how do u turn on JavaScript, to access features like WhatsApp, Facebook, Instagram....
0
by: af34tf | last post by:
Hi Guys, I have a domain whose name is BytesLimited.com, and I want to sell it. Does anyone know about platforms that allow me to list my domain in auction for free. Thank you
0
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 3 Apr 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM). In this session, we are pleased to welcome former...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.