pydps test document =================== :Author: Tibs :Version: 0.1 :Eggs: Green :Ham: Green This is intended to be a simple test document, with "something of everything". It is *not* intended to trawl for *problems*, but just to check I've got the writing out of just about everything supported in the HTML writer. :Author: Tibs :Version: 0.1 :Eggs: Green :Ham: Green :Parameter i: integer Lists ----- 1. A list 2. Some more 3. * What's this? - and this? + and this? i. And this is Roman a. And this is alpha A. And so is this I. What is this? .. Just a comment, honest. That's all. A title and some text. And another and more text. Short options: -a option a -b file option b -cname option c Long options: --aaaa option aaaa --bbbb=file option bbbb --cccc name option cccc --d-e-f-g option d-e-f-g --h_i_j_k option h_i_j_k VMS/DOS-style options: /A option A /B file option B /Cstring option C Mixed short, long, and VMS/DOS options: -a option a --bbbb=file option bbbb /C option C --dddd name option dddd -e string option e /F file option F Aliased options: -a, --aaaa, /A option a, aaaa, A -b file, --bbbb=file, /B file option b, bbbb, B Multiple lines in descriptions, aligned: -a option a, line 1 line 2 -b file option b, line 1 line 2 Multiple lines in descriptions, not aligned: -a option a, line 1 line 2 -b file option b, line 1 line 2 Some edge cases: --option=arg arg too many arguments --option=arg=arg too many arguments -aletter arg too many arguments (-a letter) /Aletter arg too many arguments (/A letter) -a=b can't use = for short arguments /A=b can't use = for DOS/VMS arguments? --option= argument missing --=argument option missing -- everything missing - this should be a bullet list item + bullet .. Comments swallow up all indented text following. (Therefore this is not a) block quote. - bullet If we want a block quote after this bullet list item, we need to use an empty comment: .. Block quote. Other blocks ------------ :: Anonymous literal block This is a literal block:: This here. And we don't need colons :: Not really. Of course, **I** like Python: >>> print " Indented block & output." Indented block & output. Or maybe I don't:: >>> print " Indented block & output." Indented block & output. Footnotes --------- Autonumbered footnotes ...................... [#]_ is the first auto-numbered footnote reference. [#]_ is the second auto-numbered footnote reference. .. [#] Auto-numbered footnote 1. .. [#] Auto-numbered footnote 2. .. [#] Auto-numbered footnote 3. [#]_ is the third auto-numbered footnote reference. Autonumbered and named footnotes ................................ [#six]_ is a reference to the sixth auto-numbered footnote. .. [#four] Fourth auto-numbered footnote. .. [#five] Fifth auto-numbered footnote. .. [#six] Sixth auto-numbered footnote. [#five]_ is a reference to the fifth auto-numbered footnote. [#four]_ is a reference to the fourth auto-numbered footnote. [#six]_ is another reference to the sixth auto-numbered footnote. Here are some internal cross-references to the implicit targets generated by the footnotes: four_, five_, six_. Mixed anonymous and labelled auto-numbered footnotes .................................................... [#ten]_ should be 10, [#]_ should be 7, [#]_ should be 9, [#]_ is one too many, [#eight]_ should be 8, and [#twelve]_ doesn't exist, nor does [#eleven]_. .. [#] Auto-numbered footnote 7. .. [#eight] Auto-numbered footnote 8. .. [#] Auto-numbered footnote 9. .. [#ten] Auto-numbered footnote 10. .. [#eleven] Auto-numbered footnote 11. .. [#eleven] Auto-numbered footnote 11 again (duplicate). Inline stuff ------------ (**strong**) but not (**) or '(** ' or x**2 or \\**kwargs or ** (however, '**kwargs' will trigger a warning and may be problematic) Strong asterisk: ***** Strong double asterisk: ****** ``literal`` ``lite\\ral`` ``literal ``TeX quotes'' & \\backslash`` but not "``" or `` (however, ``standalone TeX quotes'' will trigger a warning and may be problematic) Find the ```interpreted text``` in this paragraph! `interpreted` :role:`interpreted` `interpreted` but not \\`interpreted` [`] or ({[`] or [`]}) or ` `interpreted`-text `interpreted`: text `interpreted`:text `text`'s interpreted http://www.standalone.hyperlink.com one-slash-only:/absolute.path mailto:someone@somewhere.com news:comp.lang.python An email address in a sentence: someone@somewhere.com. ftp://ends.with.a.period. (a.question.mark@end?) Tables ------ +-------------------------------------+ | A table with one cell and one line. | +-------------------------------------+ +-----------------------+ | A malformed table. | +-----------------------+ +------------------------+ | A well-formed | table. | +------------------------+ +------------------------+ | This +----------+ too! | +------------------------+ +--------------------------+ | A table with three rows, | +------------+-------------+ | and two | columns. | +------------+-------------+ | First and last rows | | contain column spans. | +--------------------------+ +------------+-------------+---------------+ | A table | two rows in | and row spans | | with three +-------------+ to left and | | columns, | the middle, | right. | +------------+-------------+---------------+ +------------+-------------+---------------+ | A table | | two rows in | and funny | | with 3 +--+-------------+-+ stuff. | | columns, | the middle, | | | +------------+-------------+---------------+ +-----------+-------------------------+ | W/NW cell | N/NE cell | | +-------------+-----------+ | | Middle cell | E/SE cell | +-----------+-------------+ | | S/SE cell | | +-------------------------+-----------+ +--------------+-------------+ | A bad table. | | +--------------+ | | Cells must be rectangles. | +----------------------------+ +-------------------------------+ | A table with two header rows, | +------------+------------------+ | the first | with a span. | +============+==================+ | Two body | rows, | +------------+------------------+ | the second with a span. | +-------------------------------+ +-------------------------------+ | A table with two head/body | +=============+=================+ | row | separators. | +=============+=================+ | That's bad. | | +-------------+-----------------+ The traditional: +------------------------+------------+----------+----------+ | Header row, column 1 | Header 2 | Header 3 | Header 4 | +========================+============+==========+==========+ | body row 1, column 1 | column 2 | column 3 | column 4 | +------------------------+------------+----------+----------+ | body row 2 | Cells may span columns. | +------------------------+------------+---------------------+ | body row 3 | Cells may | - Table cells | +------------------------+ span rows. | - contain | | body row 4 | | - body elements. | +------------------------+------------+---------------------+ +-----------------+--------+ | A simple table | cell 2 | +-----------------+--------+ | cell 3 | cell 4 | +-----------------+--------+ No blank line after table. +-----------------+--------+ | A simple table | cell 2 | +-----------------+--------+ | cell 3 | cell 4 | +-----------------+--------+ Unexpected indent and no blank line after table. +------------------------------+ | This table contains another. | | | | +-------------------------+ | | | A table within a table. | | | +-------------------------+ | +------------------------------+ +------------------+--------+ | A simple table | | +------------------+--------+ | with empty cells | | +------------------+--------+ Links and so on --------------- .. _target: (internal hyperlink) .. _one-liner: http://structuredtext.sourceforge.net .. _starts-on-this-line: http:// structuredtext. sourceforge.net .. _entirely-below: http://structuredtext. sourceforge.net .. _target1: Not a proper hyperlink target .. _a long target name: .. _`a target name: including a colon (quoted)`: .. _a target name\: including a colon (escaped): .. _target2: http://www.python.org/ (indirect external hyperlink) Duplicate indirect links (different URIs): .. _target3: first .. _target3: second Duplicate indirect links (same URIs): .. _target4: first .. _target4: first Directives ---------- .. Attention:: Directives at large. .. Note:: This is a note. .. Tip:: 15% if the service is good. - .. WARNING:: Strong prose may provoke extreme mental exertion. Reader discretion is strongly advised. - .. Error:: Does not compute. .. Caution:: Don't take any wooden nickels. .. DANGER:: Mad scientist at work! .. Important:: - Wash behind your ears. - Clean up your room. - Call your mother. - Back up your data. .. image:: images/ball.gif .. image:: picture.png [height=100 width=200 scale=50] .. figure:: picture.png A picture with a caption. .. figure:: picture.png A picture with a caption and a legend. +-----------------------+-----------------------+ | Symbol | Meaning | +=======================+=======================+ | .. image:: tent.png | Campground | +-----------------------+-----------------------+ | .. image:: waves.png | Lake | +-----------------------+-----------------------+ | .. image:: peak.png | Mountain | +-----------------------+-----------------------+