Sample Book
Build v0.3.35
Purnank H. Ghumalia
2013.03.11
Built with Ratatouille v0.1.14
Sample Book
© MMXII Purnank Ghumalia. All rights reserved.
This book and its related website (“THE BOOK”) are an independent work of the author(s). The views and opinions
expressed in this book are of the authors only and do not
reflect the views, opinions, positions or strategies of their
current or past employers.
This book is only made available as a reference to understand
how to achieve various typographies while using Ratatouille.
THERE IS NO WARRANTY FOR “THE BOOK”, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS
AND/OR OTHER PARTIES PROVIDE “THE BOOK” “AS IS”
WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR
IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR ANY
PARTICULAR PURPOSE.
2 of 47
Sample Book
Contents
Preface
6
I
Samples
7
1 Sectioning
8
2 Example of sectioning
2.1 2012 . . . . . . . . . . . . . . . . .
2012 / January . . . . . . . . . . .
2012 / January / Monday .
2012 / February . . . . . . . . . . .
2012 / February / Tuesday
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
9
11
11
11
11
11
3 Images / Figures
12
3.1 Images . . . . . . . . . . . . . . . . . . . . . . . . . . 12
3.2 Figures . . . . . . . . . . . . . . . . . . . . . . . . . . 13
3 of 47
Sample Book
4 Tables
16
4.1 Cells totally surrounded . . . . . . . . . . . . . . . . 16
4.2 Little Less Surrounding . . . . . . . . . . . . . . . . 17
4.3 List like Table . . . . . . . . . . . . . . . . . . . . . . 18
5 Lists
22
5.1 Enumerated / Ordered . . . . . . . . . . . . . . . . . 22
5.2 Bulleted / Un-Ordered . . . . . . . . . . . . . . . . . 23
6 Notes and Warnings
25
7 Source Code
7.1 Inline Python . .
7.2 Inline C . . . . .
7.3 Include external
7.4 Include external
28
28
29
29
30
. . . . . . . . .
. . . . . . . . .
Python Script
C Code . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
8 Foot Notes
31
8.1 Example ‘ Numbered Footnotes . . . . . . . . . . . . 31
8.2 Example ‘ Footnotes with symbols . . . . . . . . . . 32
9 Text Substitution / Replacement
35
10 Cross Referencing
37
11 Index Entries
11.1 Inline (single) index entires .
11.2 Single index entry . . . . . . .
11.3 Double (paired) index entries
11.4 Triple index entries . . . . . .
39
39
40
40
41
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
12 External URLs
42
II
44
Appendix
A Contact
4 of 47
45
CONTENTS
B Build Information
46
Index
47
5 of 47
Sample Book
Preface
This book gives a preview of Ratatouille
reStructuredText 3
1
, Sphinx
2
and
It serves as a reference to show
• how individual chapters/sections are written using
reStructuredText
• how the chapters and it’s cross references are organized using Sphinx
• how Sphinx can be used to generate various formats
like HTML, PDF, ePUB, etc.
• and how Ratatouille abstracts various parts of this
process
• and how Ratatouille can be used as a delivery/distribution mechanism
1
Ratatouille — Anybody can Write and Publish!
books/ratatouille)
2
http://sphinx.pocoo.org/
3
http://docutils.sourceforge.net/rst.html
6 of 47
(http://purnank.in/-
Sample Book
Part I
Samples
7 of 47
Sample Book
CHAPTER 1
Sectioning
Chapters/Sections/Subsections are created by drawing a long
line exactly under the title. Example:
==============================================================
Chapter 1. (A double line abover and below)
==============================================================
Section 1.1. (A long line just below)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sub Section 1.1.1. (Lline below. Same Length)
‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘
You can use any of these characters for sectioning, = - ‘ :
" ~ ^ _ * + # < >
8 of 47
’
Sample Book
CHAPTER 2
Example of sectioning
This is how we write in reStructuredText
##############################################################
2012
##############################################################
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2012 / January
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
2012 / January / Monday
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
2012 / January / Monday / 10 am
--------------------------------------------------------------
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2012 / February
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9 of 47
CHAPTER 2. EXAMPLE OF SECTIONING
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
2012 / February / Tuesday
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
2012 / February / Tuesday / 10am
-------------------------------------------------------------2012 / February / Tuesday / 10am / 45min
‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘
2012 / February / Tuesday / 3pm
-------------------------------------------------------------2012 / February / Tuesday / 3pm / 15min
‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘
2012 / February / Tuesday / 3pm / 30min
‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘‘
The reStructuredText text shown above is represented as
shown below...
10 of 47
2.1. 2012
2.1 2012
2012 / January
2012 / January / Monday
2012 / January / Monday / 10 am
2012 / February
2012 / February / Tuesday
2012 / February / Tuesday / 10am
2012 / February / Tuesday / 10am / 45min
2012 / February / Tuesday / 3pm
2012 / February / Tuesday / 3pm / 15min
2012 / February / Tuesday / 3pm / 30min See more at
• Sections
(http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#sections) in reStructuredText
Markup Specification.
11 of 47
Sample Book
CHAPTER 3
Images / Figures
3.1 Images
Images are in-lined in the code. But, they don’t have crossreference.
This is how we write in reStructuredText
.. image:: /img/red-circle.*
.. image:: /img/blue-circle.*
The reStructuredText text shown above is represented as
shown below...
12 of 47
3.2. FIGURES
3.2 Figures
Figures are placed where space is are available to place this figure. i.e. it is possible that in PDF, the figure are shown on next
page. Not in continuation with the text. But, figures get a crossreference.
This is how we write in reStructuredText
.. _figure-red-circle:
.. figure:: /img/red-circle.*
A red circle
.. _figure-blue-circle:
.. figure:: /img/blue-circle.*
13 of 47
CHAPTER 3. IMAGES / FIGURES
A blue circle
The reStructuredText text shown above is represented as
shown below...
Note: Since, this is PDF format, figures may not be shown
directly below this line. They may be placed in next available
free space/page.
Figure 3.1: A red circle
Figure 3.2: A blue circle
See more at
• Image
(http://docutils.sourceforge.net/docs/ref/rst/directives.html#image) in reStructuredText Directives.
14 of 47
3.2. FIGURES
• Figure
(http://docutils.sourceforge.net/docs/ref/rst/directives.html#figure) in reStructuredText Directives.
15 of 47
Sample Book
CHAPTER 4
Tables
4.1 Cells totally surrounded
An example of table where cells are too-much surrounded by borders.
This is how we write in reStructuredText
+-----------------+------------------+
|
Logic Table
|
+-----------------+------------------+
| Inputs
| Output
|
+---------+-------+--------+---------+
| A
| B
| A or B | A and B |
+=========+=======+========+=========+
| False
| False | False | False
|
+---------+-------+--------+---------+
| False
| True | True
| False
|
+---------+-------+--------+---------+
| True
| False | True
| False
|
+---------+-------+--------+---------+
16 of 47
4.2. LITTLE LESS SURROUNDING
| True
| False | True
| True
|
+---------+-------+--------+---------+
The reStructuredText text
Logic Table
Inputs
A
B
shown below... False False
False True
True False
True False
shown above is represented as
Output
A or B
False
True
True
True
A and B
False
False
False
True
4.2 Little Less Surrounding
An example of table where cells are less surrounded by borders.
This is how we write in reStructuredText
.. tabularcolumns:: |C|C|C|C|
======
A
======
False
False
True
True
======
========
B
========
False
True
False
True
========
=========
A xor B
=========
False
True
True
False
=========
==========
A xnor B
==========
True
False
False
True
==========
The reStructuredText text shown above is represented as
17 of 47
CHAPTER 4. TABLES
shown below...
A
False
False
True
True
B
False
True
False
True
A xor B
False
True
True
False
A xnor B
True
False
False
True
4.3 List like Table
An example of table where input text is like a list.
This is how we write in reStructuredText
Table of Barsoom Series [#WIKIBARSOOM]_
.. list-table:: Barsoom Series
:widths: 6,3
:header-rows: 1
* * * * * * * * * -
18 of 47
Title
Published
A Princess of Mars
February.July 1912
The Gods of Mars
January.May 1913
The Warlord of Mars
December 1913-March 1914
Thuvia, Maid of Mars
April 1916
The Chessmen of Mars
February.March 1922
The Master Mind of Mars
July 15, 1927
A Fighting Man of Mars
April.September 1930
Swords of Mars
November 1934-April 1935
4.3. LIST LIKE TABLE
* * * * -
Synthetic Men of Mars
January.February 1939
Llana of Gathol
March.October 1941
John Carter of Mars: John Carter and the Giant of Mars
January 1941
John Carter of Mars: Skeleton Men of Jupiter
February 1943
.. [#WIKIBARSOOM] http://en.wikipedia.org/wiki/Barsoom
The reStructuredText text shown above is represented as
shown below... Table of Barsoom Series 1
1
http://en.wikipedia.org/wiki/Barsoom
19 of 47
CHAPTER 4. TABLES
Table 4.1: Barsoom Series
Title
A Princess of Mars
The Gods of Mars
The Warlord of Mars
Thuvia, Maid of Mars
The Chessmen of Mars
The Master Mind of Mars
A Fighting Man of Mars
Swords of Mars
Synthetic Men of Mars
Llana of Gathol
John Carter of Mars: John Carter and the
Giant of Mars (by John Coleman Burroughs)
John Carter of Mars: Skeleton Men of
Jupiter
Published
February.July
1912
January.May
1913
December
1913-March
1914
April 1916
February.March
1922
July 15, 1927
April.September
1930
November
1934-April
1935
January.February
1939
March.October
1941
January 1941
February
1943
See more at
• Table
(http://docutils.sourceforge.net/docs/ref/rst/directives.html#table) in reStructuredText Directives.
20 of 47
4.3. LIST LIKE TABLE
• CSV Table (http://docutils.sourceforge.net/docs/ref/rst/directives.html#id2) in reStructuredText Directives.
• List Table (http://docutils.sourceforge.net/docs/ref/rst/directives.html#list-table) in reStructuredText Directives.
• Grid
Tables
(http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#grid-tables)
in
reStructuredText Markup Specification.
• Simple
Tables
(http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#simple-tables)
in
reStructuredText Markup Specification.
21 of 47
Sample Book
CHAPTER 5
Lists
5.1 Enumerated / Ordered
An example of an enumerated/ordered list
This is how we write in reStructuredText
#. 2012
#) January
#) February
#. Tuesday
#. Thursday
#. Friday
#. 2013
The reStructuredText text shown above is represented as
shown below...
1. 2012
(a) January
22 of 47
5.2. BULLETED / UN-ORDERED
(b) February
i. Tuesday
ii. Thursday
iii. Friday
2. 2013
5.2 Bulleted / Un-Ordered
An example of an bulleted/un-ordered list
This is how we write in reStructuredText
* 2012 / January
+ Monday
- 10:00 :
- 13:00 :
2012
/
February
*
+ Tuesday
- 10:45 :
- 15:00 :
breakfast
Lunch
late breakfast
very late lunch
The reStructuredText text shown above is represented as
shown below...
• 2012 / January
– Monday
* 10:00 : breakfast
* 13:00 : Lunch
• 2012 / February
– Tuesday
23 of 47
CHAPTER 5. LISTS
* 10:45 : late breakfast
* 15:00 : very late lunch
See more at
• Bulleted
Lists
(http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#bullet-lists)
in
reStructuredText Markup Specification.
• Enumerated
Lists
(http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#enumerated-lists2) in
reStructuredText Markup Specification.
• Definition
Lists
(http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#definition-lists)
in
reStructuredText Markup Specification
• Field Lists (http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#field-lists) in reStructuredText
Markup Specification
• Option
Lists
(http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#option-lists)
in
reStructuredText Markup Specification
24 of 47
Sample Book
CHAPTER 6
Notes and Warnings
This is how we write in reStructuredText
.. note:: Note
for the user
Some details for this note.
- Item 1
- Item 2
.. tip:: Tip
for the user
.. hint:: Hint
for the user
.. important:: Important
.. warning:: Warning
for the user
for the user
.. attention:: Attention for the user
.. caution:: Caution for the user
25 of 47
CHAPTER 6. NOTES AND WARNINGS
.. danger:: Danger for the user
.. error:: Error for the user
The reStructuredText text shown above is represented as
shown below...
Note: Note for the user
Some details for this note.
• Item 1
• Item 2
Tip: Tip for the user
Hint: Hint for the user
Important: Important for the user
Warning: Warning for the user
Attention: Attention for the user
Caution: Caution for the user
Danger: Danger for the user
26 of 47
Error: Error for the user
See more at
• Admonitions (http://docutils.sourceforge.net/docs/ref/rst/directives.html#admonitions) in reStructuredText
Directives.
27 of 47
Sample Book
CHAPTER 7
Source Code
7.1 Inline Python
This is how we write in reStructuredText
.. code-block:: python
:emphasize-lines: 2,4
def myEntryPoint(myParam):
# validate myParam
print ("Processing myParam")
# log the output
The reStructuredText text shown above is represented as
shown below...
def myEntryPoint(myParam):
# validate myParam
print ("Processing myParam")
# log the output
28 of 47
7.2. INLINE C
7.2 Inline C
This is how we write in reStructuredText
.. code-block:: c
:emphasize-lines: 3
int myEntryPoint(int myParam) {
int retVal;
/* validate myParam */
printf("Processing myParam");
retVal = process_theParam(myParam);
/* log the output */
return retVal;
}
The reStructuredText text shown above is represented as
shown below...
int myEntryPoint(int myParam) {
int retVal;
/* validate myParam */
printf("Processing myParam");
retVal = process_theParam(myParam);
/* log the output */
return retVal;
}
7.3 Include external Python Script
This is how we write in reStructuredText
29 of 47
CHAPTER 7. SOURCE CODE
.. literalinclude:: source-code.sample.py.txt
:language: python
The reStructuredText text shown above is represented as
shown below...
def myEntryPoint(myParam):
# validate myParam
print ("Processing myParam")
# log the output
7.4 Include external C Code
This is how we write in reStructuredText
.. literalinclude:: source-code.sample.c.txt
:language: c
The reStructuredText text shown above is represented as
shown below...
int myEntryPoint(int myParam) {
int retVal;
/* validate myParam */
printf("Processing myParam");
retVal = process_theParam(myParam);
/* log the output */
return retVal;
}
See more at
• Showing code examples (http://sphinx-doc.org/markup/code.html) in Sphinx Documentation.
30 of 47
Sample Book
CHAPTER 8
Foot Notes
Numbered footnotes can be written with [#]_, [*]_ or [#TEXT]_
8.1 Example ‘ Numbered Footnotes
This is how we write in reStructuredText
Numbered footnotes:
-
Numbered
Numbered
Numbered
Numbered
1
2
3
4
[#]_
[#]_
[#EXPLICIT]_
[#EXPLICIT]_
(will
(will
(will
(will
refer to first footnote)
refer to second footnote)
explicitly refer to third fo
also explicitly refer to thi
----.. [#] Numbered 1
.. [#] Numbered 2
.. [#EXPLICIT] Numbered 2
31 of 47
CHAPTER 8. FOOT NOTES
The reStructuredText text shown above is represented as
shown below...
Numbered footnotes:
• Numbered 1
1
(will refer to first footnote)
• Numbered 2
2
(will refer to second footnote)
• Numbered 3
3
(will explicitly refer to third footnote)
• Numbered 4
3
(will also explicitly refer to third footnote)
8.2 Example ‘ Footnotes with symbols
HTML based output can show footnotes with symbols also. But,
in non‘html layouts, the footnote‘references translate to numbers only.
This is how we write in reStructuredText
Footnotes with symbols
-
Text
Text
Text
Text
Text
for
for
for
for
for
symbol
symbol
symbol
symbol
symbol
1
2
3
4
5
[*]_,
[*]_,
[*]_,
[*]_,
[*]_, etc.
.. [*] Footnote for symbol 1
.. [*] Footnote for symbol 2
.. [*] Footnote for symbol 3
1
2
3
Numbered 1
Numbered 2
Numbered 2
32 of 47
8.2. EXAMPLE ‘ FOOTNOTES WITH SYMBOLS
.. [*] Footnote for symbol 4
.. [*] Footnote for symbol 5
The reStructuredText text shown above is represented as
shown below...
Footnotes with symbols
• Text for symbol 1 4 ,
• Text for symbol 2 5 ,
• Text for symbol 3 6 ,
• Text for symbol 4 7 ,
• Text for symbol 5 8 , etc.
See more at
• Footnotes (http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#footnotes) in reStructuredText
Markup Specification.
• Auto-Numbered
Footnotes
(http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#auto-numbered-footnotes)
in
reStructuredText Markup Specification.
• Auto-Symbol Footnotes (http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#auto-symbolfootnotes) in reStructuredText Markup Specification.
4
5
6
7
8
Footnote
Footnote
Footnote
Footnote
Footnote
for
for
for
for
for
symbol
symbol
symbol
symbol
symbol
1
2
3
4
5
33 of 47
CHAPTER 8. FOOT NOTES
• Mixed
Manual
and
Auto-Numbered
Footnotes
(http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#mixed-manual-and-autonumbered-footnotes) in reStructuredText Markup
Specification.
34 of 47
Sample Book
CHAPTER 9
Text Substitution / Replacement
This is how we write in reStructuredText
.. |u| replace:: **Ratatouille**
.. |t| replace:: :samp:‘reStructuredText‘
|u| is heavily dependent on |t|. It is so
easy to wrongly mix capitalization on |t| or
make spelling mistake in |u|. Even more when
the book itself is about |u|. But thanks to
substitution feature of |t|, we are saved.
The reStructuredText text shown above is represented as
shown below...
Ratatouille is heavily dependent on reStructuredText. It is
so easy to wrongly mix capitalization on reStructuredText or
make spelling mistake in Ratatouille. Even more when the book
itself is about Ratatouille. But thanks to substitution feature of
reStructuredText, we are saved.
35 of 47
CHAPTER 9. TEXT SUBSTITUTION / REPLACEMENT
See more at
• Substitution Definitions (http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#substitutiondefinitions) in reStructuredText Markup Specification.
• Replacement
Text
(http://docutils.sourceforge.net/docs/ref/rst/directives.html#replacement-text)
in
reStructuredText Directives.
• Unicode
Text
(http://docutils.sourceforge.net/docs/ref/rst/directives.html#unicode-character-codes)
in
reStructuredText Directives
36 of 47
Sample Book
CHAPTER 10
Cross Referencing
To cross reference different parts of the book, first step
is to identify canonical names/ids for the reference.
e.g.
section-figures and figure-red-circle. The canonical
names/ids are only needed to uniquely identify the cross references. By default, the references show the actual text of the
heading and figure.
For Heading (Chapter 1, page 8) the entries are defined like this:
.. _section-figures:
Figures
=========
For Figures (Section 3.2, page 13), the entries are defined like
this (See line 1 and 7)
1
.. _figure-red-circle:
2
3
.. figure:: /img/red-circle.*
4
5
A red circle
37 of 47
CHAPTER 10. CROSS REFERENCING
6
7
.. _figure-blue-circle:
8
9
.. figure:: /img/blue-circle.*
10
11
A blue circle
This is how we write in reStructuredText
See :ref:‘figure-red-circle‘ and
:ref:‘figure-blue-circle‘
(They are shown as part of
:ref:‘section-figures‘ of
:ref:‘chapter-images-and-figures‘ )
We can also use our name for
:ref:‘The section about Figures <section-figures>‘
The reStructuredText text shown above is represented as
shown below...
See A red circle (Figure 3.1, page 14) and A blue circle (Figure 3.2,
page 14) (They are shown as part of Figures (Section 3.2, page
13) of Images / Figures (Chapter 3, page 12) )
We can also use our name for The section about Figures (Section 3.2, page 13)
See more at
• Cross-referencing arbitrary locations (http://sphinxdoc.org/markup/inline.html#cross-referencing-syntax) in
Sphinx Documentation.
38 of 47
Sample Book
CHAPTER 11
Index Entries
Note: For the generated indexes, see genindex
11.1 Inline (single) index entires
This is how we write in reStructuredText
:index:‘Inlined <inlined-entry>‘ :index:‘index‘ :index:‘entry‘
Inlined index entry
The generated entries are:
• inlined-entry
• index
• entry
39 of 47
CHAPTER 11. INDEX ENTRIES
11.2 Single index entry
This is how we write in reStructuredText
.. index:: single
.. index:: explicit-one
.. index:: explicit single line
The generated entries are:
• single
• explicit-one
• explicit single line
11.3 Double (paired) index entries
This is how we write in reStructuredText
.. index::
pair: double; index entries
pair: paired; index entries
pair: two; index entries
The generated entries are:
• double
– index entries
• index entries
– double
– paired
– two
40 of 47
11.4. TRIPLE INDEX ENTRIES
• paired
– index entries
• two
– index entries
11.4 Triple index entries
This is how we write in reStructuredText
.. index::
triple: three; tres; drei
Three index entires, THREE in English, TRES in Spanish, DREI
in German.
The generated entries are:
• tres
– drei, three
• drei
– three, tres
• three
– tres, drei
41 of 47
Sample Book
CHAPTER 12
External URLs
This is how we write in reStructuredText
- Direct URL
- http://twitter.com/poornank
- ‘Twitter @poornank <http://twitter.com/poornank>‘_
- Indirect URL
- ‘Twitter @poornank‘_
- @\ poornank_
- Long URL
- https://www.google.co.in/search?q=purnank+ghumalia+p
- ‘Search purnank in goolge <https://www.google.co.in/
- Tildae in URL
- http://purnank.in/~home
- ‘purnank.in/~home <http://purnank.in/~home>‘_
- Underscore in URL
- http://purnank.in/H_O_M_E
- ‘purnank.in/H_O_M_E <http://purnank.in/H_O_M_E>‘_
.. _ http://twitter.com/poornank
42 of 47
.. _poornank: http://twitter.com/poornank
The reStructuredText text shown above is represented as
shown below...
• Direct URL
– http://twitter.com/poornank
– Twitter @poornank (http://twitter.com/poornank)
• Indirect URL
– Twitter @poornank (http://twitter.com/poornank)
– @poornank (http://twitter.com/poornank)
• Long URL
– https://www.google.co.in/search?q=purnank+ghumalia+purnank+ghumalia+purnank+ghumalia+purnank+ghumalia+purnank+ghumalia
– Search
purnank
in
goolge
(https://www.google.co.in/search?q=purnank+ghumalia+purnank+ghumalia+purnank+ghumalia+purnank+ghumalia+purnank+ghumalia=UTF-8)
• Tildae in URL
– http://purnank.in/~home
– purnank.in/~home (http://purnank.in/ home)
• Underscore in URL
– http://purnank.in/H_O_M_E
– purnank.in/H_O_M_E
H_O_M_E)
(http://purnank.in/-
43 of 47
Sample Book
Part II
Appendix
44 of 47
Sample Book
APPENDIX A
Contact
Contact author at
• @poornank (http://twitter.com/poornank)
• @LeanReligion (https://twitter.com/LeanReligion)
• +Purnank
H
G
(https://plus.google.com/100317982503110503355/)
• me @ purnank.in ([email protected])
• book @ dehlia.in ([email protected])
45 of 47
Sample Book
APPENDIX B
Build Information
The content of this book is generated from the following version
of the book.
Book Version v0.3.35
Last GIT Tag v0.3
GIT Hash a06ceb83ed6661de9d29e75c537191d7f749d82a
Ratatouille v0.1.14
46 of 47
Sample Book
Index
D
S
double
index entries, 38
drei
three tres, 39
single, 38
E
entry, 37
explicit single line, 38
explicit-one, 38
T
three
tres drei, 39
tres
drei, three, 39
two
index entries, 38
I
index, 37
index entries
double, 38
paired, 38
two, 38
inlined-entry, 37
P
paired
index entries, 38
47 of 47