diff --git a/_build/doctrees/environment.pickle b/_build/doctrees/environment.pickle index 7dc5de2..d2aa105 100644 --- a/_build/doctrees/environment.pickle +++ b/_build/doctrees/environment.pickle Binary files differ diff --git a/_build/doctrees/index.doctree b/_build/doctrees/index.doctree index f37bae6..3d66172 100644 --- a/_build/doctrees/index.doctree +++ b/_build/doctrees/index.doctree Binary files differ diff --git a/_build/doctrees/intro.doctree b/_build/doctrees/intro.doctree index 6593d30..0c146a8 100644 --- a/_build/doctrees/intro.doctree +++ b/_build/doctrees/intro.doctree Binary files differ diff --git a/_build/doctrees/tutorial.doctree b/_build/doctrees/tutorial.doctree index 1bdbf26..556cf9b 100644 --- a/_build/doctrees/tutorial.doctree +++ b/_build/doctrees/tutorial.doctree Binary files differ diff --git a/_build/html/.buildinfo b/_build/html/.buildinfo index b20d291..7111730 100644 --- a/_build/html/.buildinfo +++ b/_build/html/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: c036e65ca7feed2a91da20ce77171f3f +config: 07e9ca8605bd8fb554d52765d01ea2e5 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/_build/html/_sources/index.rst.txt b/_build/html/_sources/index.rst.txt index 38f855b..4c18f2d 100644 --- a/_build/html/_sources/index.rst.txt +++ b/_build/html/_sources/index.rst.txt @@ -11,6 +11,7 @@ :caption: Contents: intro + arduino tutorial conclusion diff --git a/_build/html/_sources/intro.rst.txt b/_build/html/_sources/intro.rst.txt index 751b632..e4aaa6a 100644 --- a/_build/html/_sources/intro.rst.txt +++ b/_build/html/_sources/intro.rst.txt @@ -1,6 +1,59 @@ -Intro +イントロダクションIntro =================================== -ここはIntroです。 +ここはIntroです。:ref:`isprime` に、ソースコードの例を示します。 + +.. code-block:: + + #include + + int isprime(int n){ + int i; + for(i=2;i for introductory docs. +:Author: David Goodger +:Date: $Date: 2013-02-20 02:10:53 +0100 (Mi, 20. Feb 2013) $ +:Revision: $Revision: 7612 $ +:Description: This is a "docinfo block", or bibliographic field list + +.. NOTE:: If you are reading this as HTML, please read + ``_ instead to see the input syntax examples! + +Section Structure +================= +Section titles are underlined or overlined & underlined. + +Body Elements +============= +Grid table: + ++--------------------------------+-----------------------------------+ +| Paragraphs are flush-left, | Literal block, preceded by "::":: | +| separated by blank lines. | | +| | Indented | +| Block quotes are indented. | | ++--------------------------------+ or:: | +| >>> print 'Doctest block' | | +| Doctest block | > Quoted | ++--------------------------------+-----------------------------------+ +| | Line blocks preserve line breaks & indents. [new in 0.3.6] | +| | Useful for addresses, verse, and adornment-free lists; long | +| lines can be wrapped with continuation lines. | ++--------------------------------------------------------------------+ + +Simple tables: + +================ ============================================================ +List Type Examples (syntax in the `text source `_) +================ ============================================================ +Bullet list * items begin with "-", "+", or "*" +Enumerated list 1. items use any variation of "1.", "A)", and "(i)" + #. also auto-enumerated +Definition list Term is flush-left : optional classifier + Definition is indented, no blank line between +Field list :field name: field body +Option list -o at least 2 spaces between option & description +================ ============================================================ + +================ ============================================================ +Explicit Markup Examples (visible in the `text source`_) +================ ============================================================ +Footnote .. [1] Manually numbered or [#] auto-numbered + (even [#labelled]) or [*] auto-symbol +Citation .. [CIT2002] A citation. +Hyperlink Target .. _reStructuredText: http://docutils.sf.net/rst.html + .. _indirect target: reStructuredText_ + .. _internal target: +Anonymous Target __ http://docutils.sf.net/docs/ref/rst/restructuredtext.html +Directive ("::") .. image:: images/biohazard.png +Substitution Def .. |substitution| replace:: like an inline directive +Comment .. is anything else +Empty Comment (".." on a line by itself, with blank lines before & after, + used to separate indentation contexts) +================ ============================================================ + +Inline Markup +============= +*emphasis*; **strong emphasis**; `interpreted text`; `interpreted text +with role`:emphasis:; ``inline literal text``; standalone hyperlink, +http://docutils.sourceforge.net; named reference, reStructuredText_; +`anonymous reference`__; footnote reference, [1]_; citation reference, +[CIT2002]_; |substitution|; _`inline internal target`. + +Directive Quick Reference +========================= +See for full info. + +================ ============================================================ +Directive Name Description (Docutils version added to, in [brackets]) +================ ============================================================ +attention Specific admonition; also "caution", "danger", + "error", "hint", "important", "note", "tip", "warning" +admonition Generic titled admonition: ``.. admonition:: By The Way`` +image ``.. image:: picture.png``; many options possible +figure Like "image", but with optional caption and legend +topic ``.. topic:: Title``; like a mini section +sidebar ``.. sidebar:: Title``; like a mini parallel document +parsed-literal A literal block with parsed inline markup +rubric ``.. rubric:: Informal Heading`` +epigraph Block quote with class="epigraph" +highlights Block quote with class="highlights" +pull-quote Block quote with class="pull-quote" +compound Compound paragraphs [0.3.6] +container Generic block-level container element [0.3.10] +table Create a titled table [0.3.1] +list-table Create a table from a uniform two-level bullet list [0.3.8] +csv-table Create a table from CSV data [0.3.4] +contents Generate a table of contents +sectnum Automatically number sections, subsections, etc. +header, footer Create document decorations [0.3.8] +target-notes Create an explicit footnote for each external target +math Mathematical notation (input in LaTeX format) +meta HTML-specific metadata +include Read an external reST file as if it were inline +raw Non-reST data passed untouched to the Writer +replace Replacement text for substitution definitions +unicode Unicode character code conversion for substitution defs +date Generates today's date; for substitution defs +class Set a "class" attribute on the next element +role Create a custom interpreted text role [0.3.2] +default-role Set the default interpreted text role [0.3.10] +title Set the metadata document title [0.3.10] +================ ============================================================ + +Interpreted Text Role Quick Reference +===================================== +See for full info. + +================ ============================================================ +Role Name Description +================ ============================================================ +emphasis Equivalent to *emphasis* +literal Equivalent to ``literal`` but processes backslash escapes +math Mathematical notation (input in LaTeX format) +PEP Reference to a numbered Python Enhancement Proposal +RFC Reference to a numbered Internet Request For Comments +raw For non-reST data; cannot be used directly (see docs) [0.3.6] +strong Equivalent to **strong** +sub Subscript +sup Superscript +title Title reference (book, etc.); standard default role +================ ============================================================ + diff --git a/_build/html/_static/pygments.css b/_build/html/_static/pygments.css index dd6621d..631bc92 100644 --- a/_build/html/_static/pygments.css +++ b/_build/html/_static/pygments.css @@ -1,77 +1,69 @@ .highlight .hll { background-color: #ffffcc } .highlight { background: #f8f8f8; } -.highlight .c { color: #8f5902; font-style: italic } /* Comment */ -.highlight .err { color: #a40000; border: 1px solid #ef2929 } /* Error */ -.highlight .g { color: #000000 } /* Generic */ -.highlight .k { color: #004461; font-weight: bold } /* Keyword */ -.highlight .l { color: #000000 } /* Literal */ -.highlight .n { color: #000000 } /* Name */ -.highlight .o { color: #582800 } /* Operator */ -.highlight .x { color: #000000 } /* Other */ -.highlight .p { color: #000000; font-weight: bold } /* Punctuation */ -.highlight .ch { color: #8f5902; font-style: italic } /* Comment.Hashbang */ -.highlight .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */ -.highlight .cp { color: #8f5902 } /* Comment.Preproc */ -.highlight .cpf { color: #8f5902; font-style: italic } /* Comment.PreprocFile */ -.highlight .c1 { color: #8f5902; font-style: italic } /* Comment.Single */ -.highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */ -.highlight .gd { color: #a40000 } /* Generic.Deleted */ -.highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */ -.highlight .gr { color: #ef2929 } /* Generic.Error */ +.highlight .c { color: #408080; font-style: italic } /* Comment */ +.highlight .err { border: 1px solid #FF0000 } /* Error */ +.highlight .k { color: #008000; font-weight: bold } /* Keyword */ +.highlight .o { color: #666666 } /* Operator */ +.highlight .ch { color: #408080; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #408080; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #BC7A00 } /* Comment.Preproc */ +.highlight .cpf { color: #408080; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #408080; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #408080; font-style: italic } /* Comment.Special */ +.highlight .gd { color: #A00000 } /* Generic.Deleted */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .gr { color: #FF0000 } /* Generic.Error */ .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ .highlight .gi { color: #00A000 } /* Generic.Inserted */ .highlight .go { color: #888888 } /* Generic.Output */ -.highlight .gp { color: #745334 } /* Generic.Prompt */ -.highlight .gs { color: #000000; font-weight: bold } /* Generic.Strong */ +.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */ +.highlight .gs { font-weight: bold } /* Generic.Strong */ .highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ -.highlight .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */ -.highlight .kc { color: #004461; font-weight: bold } /* Keyword.Constant */ -.highlight .kd { color: #004461; font-weight: bold } /* Keyword.Declaration */ -.highlight .kn { color: #004461; font-weight: bold } /* Keyword.Namespace */ -.highlight .kp { color: #004461; font-weight: bold } /* Keyword.Pseudo */ -.highlight .kr { color: #004461; font-weight: bold } /* Keyword.Reserved */ -.highlight .kt { color: #004461; font-weight: bold } /* Keyword.Type */ -.highlight .ld { color: #000000 } /* Literal.Date */ -.highlight .m { color: #990000 } /* Literal.Number */ -.highlight .s { color: #4e9a06 } /* Literal.String */ -.highlight .na { color: #c4a000 } /* Name.Attribute */ -.highlight .nb { color: #004461 } /* Name.Builtin */ -.highlight .nc { color: #000000 } /* Name.Class */ -.highlight .no { color: #000000 } /* Name.Constant */ -.highlight .nd { color: #888888 } /* Name.Decorator */ -.highlight .ni { color: #ce5c00 } /* Name.Entity */ -.highlight .ne { color: #cc0000; font-weight: bold } /* Name.Exception */ -.highlight .nf { color: #000000 } /* Name.Function */ -.highlight .nl { color: #f57900 } /* Name.Label */ -.highlight .nn { color: #000000 } /* Name.Namespace */ -.highlight .nx { color: #000000 } /* Name.Other */ -.highlight .py { color: #000000 } /* Name.Property */ -.highlight .nt { color: #004461; font-weight: bold } /* Name.Tag */ -.highlight .nv { color: #000000 } /* Name.Variable */ -.highlight .ow { color: #004461; font-weight: bold } /* Operator.Word */ -.highlight .w { color: #f8f8f8; text-decoration: underline } /* Text.Whitespace */ -.highlight .mb { color: #990000 } /* Literal.Number.Bin */ -.highlight .mf { color: #990000 } /* Literal.Number.Float */ -.highlight .mh { color: #990000 } /* Literal.Number.Hex */ -.highlight .mi { color: #990000 } /* Literal.Number.Integer */ -.highlight .mo { color: #990000 } /* Literal.Number.Oct */ -.highlight .sa { color: #4e9a06 } /* Literal.String.Affix */ -.highlight .sb { color: #4e9a06 } /* Literal.String.Backtick */ -.highlight .sc { color: #4e9a06 } /* Literal.String.Char */ -.highlight .dl { color: #4e9a06 } /* Literal.String.Delimiter */ -.highlight .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */ -.highlight .s2 { color: #4e9a06 } /* Literal.String.Double */ -.highlight .se { color: #4e9a06 } /* Literal.String.Escape */ -.highlight .sh { color: #4e9a06 } /* Literal.String.Heredoc */ -.highlight .si { color: #4e9a06 } /* Literal.String.Interpol */ -.highlight .sx { color: #4e9a06 } /* Literal.String.Other */ -.highlight .sr { color: #4e9a06 } /* Literal.String.Regex */ -.highlight .s1 { color: #4e9a06 } /* Literal.String.Single */ -.highlight .ss { color: #4e9a06 } /* Literal.String.Symbol */ -.highlight .bp { color: #3465a4 } /* Name.Builtin.Pseudo */ -.highlight .fm { color: #000000 } /* Name.Function.Magic */ -.highlight .vc { color: #000000 } /* Name.Variable.Class */ -.highlight .vg { color: #000000 } /* Name.Variable.Global */ -.highlight .vi { color: #000000 } /* Name.Variable.Instance */ -.highlight .vm { color: #000000 } /* Name.Variable.Magic */ -.highlight .il { color: #990000 } /* Literal.Number.Integer.Long */ \ No newline at end of file +.highlight .gt { color: #0044DD } /* Generic.Traceback */ +.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #008000 } /* Keyword.Pseudo */ +.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #B00040 } /* Keyword.Type */ +.highlight .m { color: #666666 } /* Literal.Number */ +.highlight .s { color: #BA2121 } /* Literal.String */ +.highlight .na { color: #7D9029 } /* Name.Attribute */ +.highlight .nb { color: #008000 } /* Name.Builtin */ +.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */ +.highlight .no { color: #880000 } /* Name.Constant */ +.highlight .nd { color: #AA22FF } /* Name.Decorator */ +.highlight .ni { color: #999999; font-weight: bold } /* Name.Entity */ +.highlight .ne { color: #D2413A; font-weight: bold } /* Name.Exception */ +.highlight .nf { color: #0000FF } /* Name.Function */ +.highlight .nl { color: #A0A000 } /* Name.Label */ +.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ +.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #19177C } /* Name.Variable */ +.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ +.highlight .w { color: #bbbbbb } /* Text.Whitespace */ +.highlight .mb { color: #666666 } /* Literal.Number.Bin */ +.highlight .mf { color: #666666 } /* Literal.Number.Float */ +.highlight .mh { color: #666666 } /* Literal.Number.Hex */ +.highlight .mi { color: #666666 } /* Literal.Number.Integer */ +.highlight .mo { color: #666666 } /* Literal.Number.Oct */ +.highlight .sa { color: #BA2121 } /* Literal.String.Affix */ +.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */ +.highlight .sc { color: #BA2121 } /* Literal.String.Char */ +.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */ +.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #BA2121 } /* Literal.String.Double */ +.highlight .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */ +.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */ +.highlight .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */ +.highlight .sx { color: #008000 } /* Literal.String.Other */ +.highlight .sr { color: #BB6688 } /* Literal.String.Regex */ +.highlight .s1 { color: #BA2121 } /* Literal.String.Single */ +.highlight .ss { color: #19177C } /* Literal.String.Symbol */ +.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */ +.highlight .fm { color: #0000FF } /* Name.Function.Magic */ +.highlight .vc { color: #19177C } /* Name.Variable.Class */ +.highlight .vg { color: #19177C } /* Name.Variable.Global */ +.highlight .vi { color: #19177C } /* Name.Variable.Instance */ +.highlight .vm { color: #19177C } /* Name.Variable.Magic */ +.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/_build/html/conclusion.html b/_build/html/conclusion.html index 031ede9..b79a8f8 100644 --- a/_build/html/conclusion.html +++ b/_build/html/conclusion.html @@ -1,109 +1,220 @@ - - - - - Conclusion — TestRTP ドキュメント - - - - - - - - + + + + + + + + Conclusion — TestRTP ドキュメント + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + - - - - - - - - -
-
-
+
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+

Conclusion

+
+
- +
-
+
+ + - - - - -

ナビゲーション

-

Contents:

- - -
-

Related Topics

- -
- - - - - - - - - - -
-
-
-
-
- ©2021, Motoki Miura. - - | - Powered by Sphinx 2.4.0 - & Alabaster 0.7.12 - - | - Page source -
- + + + - - + \ No newline at end of file diff --git a/_build/html/genindex.html b/_build/html/genindex.html index e186dfc..a47f15a 100644 --- a/_build/html/genindex.html +++ b/_build/html/genindex.html @@ -1,36 +1,168 @@ + + + + + + + + 索引 — TestRTP ドキュメント + - - - - 索引 — TestRTP ドキュメント - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + - - - - - - - - -
-
-
+
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
    + +
  • »
    • + +
  • 索引
    • + + +
  • + + + +
    • + +
+ + +
+
+
+

索引

@@ -40,69 +172,47 @@
+
+
- +
+ +
+ +
+

+ © Copyright 2021, Motoki Miura. + +

+
+ + + + Built with Sphinx using a + + theme + + provided by Read the Docs. + +
- -
-
-
-
- ©2021, Motoki Miura. - - | - Powered by Sphinx 2.4.0 - & Alabaster 0.7.12 - -
- + + + - - + \ No newline at end of file diff --git a/_build/html/index.html b/_build/html/index.html index a6a9911..f9f81fb 100644 --- a/_build/html/index.html +++ b/_build/html/index.html @@ -1,44 +1,187 @@ - - - - - Welcome to TestRTP's documentation! — TestRTP ドキュメント - - - - - - - - + + + + + + + + Welcome to TestRTP's documentation! — TestRTP ドキュメント + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + - - - - - - - - -
-
-
+
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
    + +
  • »
    • + +
  • Welcome to TestRTP's documentation!
    • + + +
  • + + + View page source + + +
    • + +
+ + +
+
+
+ +
- +
-
+
+ + - - - - -

ナビゲーション

-

Contents:

- - -
-

Related Topics

- -
- - - - - - - - - - -
-
-
-
-
- ©2021, Motoki Miura. - - | - Powered by Sphinx 2.4.0 - & Alabaster 0.7.12 - - | - Page source -
- + + + - - + \ No newline at end of file diff --git a/_build/html/intro.html b/_build/html/intro.html index e6765c0..90a6861 100644 --- a/_build/html/intro.html +++ b/_build/html/intro.html @@ -1,112 +1,274 @@ - - - - - Intro — TestRTP ドキュメント - - - - - - - - + + + + + + + + イントロダクションIntro — TestRTP ドキュメント + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - + + + + + + - - - - - - - - -
-
-
+
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
-
-
-
-
- ©2021, Motoki Miura. - - | - Powered by Sphinx 2.4.0 - & Alabaster 0.7.12 - - | - Page source -
- +
+
+ + + + + + - + + + \ No newline at end of file diff --git a/_build/html/objects.inv b/_build/html/objects.inv index a55f623..32fc7d1 100644 --- a/_build/html/objects.inv +++ b/_build/html/objects.inv Binary files differ diff --git a/_build/html/search.html b/_build/html/search.html index e5a85c9..547c4df 100644 --- a/_build/html/search.html +++ b/_build/html/search.html @@ -1,114 +1,230 @@ + + + + + + + + 検索 — TestRTP ドキュメント + - - - - 検索 — TestRTP ドキュメント - - + + + + + + + + + + + + + + - - - - - - - + + + + + + + + + + + + + + + + + - - - + + + + + - - - - - - - - - -
-
-
+
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
    + +
  • »
    • + +
  • 検索
    • + + +
  • + +
    • + +
+ + +
+
+
+
+ + +
+
+
- +
+ +
+ +
+

+ © Copyright 2021, Motoki Miura. + +

+
+ + + + Built with Sphinx using a + + theme + + provided by Read the Docs. + +
-
+
+ + - - - - -

ナビゲーション

-

Contents:

- - -
-

Related Topics

- -
- - - - - - - - -
-
-
-
-
- ©2021, Motoki Miura. - - | - Powered by Sphinx 2.4.0 - & Alabaster 0.7.12 - -
- + + + + + + + - - + + \ No newline at end of file diff --git a/_build/html/searchindex.js b/_build/html/searchindex.js index 9a4dca0..323d570 100644 --- a/_build/html/searchindex.js +++ b/_build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["conclusion","index","intro","tutorial"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":1,"sphinx.domains.index":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,sphinx:56},filenames:["conclusion.rst","index.rst","intro.rst","tutorial.rst"],objects:{},objnames:{},objtypes:{},terms:{"\u3053\u3053":[2,3],"\u3067\u3059":[2,3],"\u30c1\u30e5\u30fc\u30c8\u30ea\u30a2\u30eb":3,"\u30da\u30fc\u30b8":1,"\u30e2\u30b8\u30e5\u30fc\u30eb":1,"\u691c\u7d22":1,"\u7d22\u5f15":1,conclusion:1,contents:1,intro:1,tutorial:1},titles:["Conclusion","Welcome to TestRTP's documentation!","Intro","Tutorial"],titleterms:{"'s":1,and:1,conclusion:0,documentation:1,indices:1,intro:2,tables:1,testrtp:1,to:1,tutorial:3,welcome:1}}) \ No newline at end of file +Search.setIndex({docnames:["arduino","conclusion","index","intro","tutorial"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":1,"sphinx.domains.index":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,sphinx:56},filenames:["arduino.rst","conclusion.rst","index.rst","intro.rst","tutorial.rst"],objects:{},objnames:{},objtypes:{},terms:{"!\\":[],"#]":4,"#include":[0,3],"$date":4,"$revision":4,"%.":[],"%i":3,"&&":[],"&databuff":[],"'s":4,"( i":[],"(!":[],"(&":[],"((":[],"()":0,"(-":[],"(\"":3,"(accy":[],"(addrcheckbuff":[],"(blecharacteristic":[],"(blename":[],"(bleserver":[],"(buffptr":[],"(const":[],"(count":[],"(data":[],"(disbuff":[],"(drawdisplay":[],"(esp":[],"(float":[],"(gpio":[],"(humraw":[],"(i":[3,4],"(int":3,"(irtxsem":[],"(m":[],"(micrecordfft":[],"(n":[],"(new":[],"(num":3,"(point":[],"(real":[],"(rmt":[],"(senddata":[],"(service":[],"(sizeof":[],"(src":[],"(start":[],"(str":[],"(strbuff":[],"(string":[],"(tempraw":[],"(tft":[],"(timer":[],"(true":[],"(tx":[],"(uint":[],"(void":3,"(white":[],"(x":[],"(xsemaphore":[],"(y":[],"(z":[],")(":[],"))":[],")*":[],"),":[],");":3,")\"":4,")\\":3,")]":[],")map":[],")n":[],"){":3,"*/":[],"*\"":4,"*]":4,"+ (":[],"++":3,"+;":[],"+\"":4,", \"":4,", and":4,", num":3,", or":4,",&":[],",*temp":[],",\"":[],",\n}":[],",_":[],"- (":[],"-(":[],"--":[],"->":[],"-\"":4,"-enumerated":4,"-f":[],"-free":4,"-left":4,"-level":4,"-literal":4,"-notes":4,"-numbered":4,"-o":4,"-quote":4,"-rest":4,"-role":4,"-specific":4,"-symbol":4,"-table":4,".)":4,"..":4,".\"":4,".\\":3,".b":[],".bck":[],".begin":[],".begintransmission":[],".c":3,".carrier":[],".channel":[],".clk":[],".color":[],".createsprite":[],".data":[],".drawline":[],".drawpixel":[],".drawrect":[],".drawstring":[],".end":[],".endtransmission":[],".fillrect":[],".g":[],".getacceldata":[],".getbatvoltage":[],".getbm":[],".getbtnpress":[],".getefusemac":[],".gettime":[],".getvinvoltage":[],".gpio":[],".h":[0,3],".hours":[],".html":4,".idle":[],".init":[],".ino":0,".ispressed":[],".loop":[],".mem":[],".minutes":[],".mute":[],".n":[],".net":4,".org":4,".png":4,".printf":[],".println":[],".pushimage":[],".pushsprite":[],".r":[],".read":[],".requestfrom":[],".restart":[],".rmt":[],".screenbreath":[],".seconds":[],".setcursor":[],".setrotation":[],".setswapbytes":[],".settextcolor":[],".settextfont":[],".settextsize":[],".sf":4,".sourceforge":4,".start":[],".tone":[],".tx":[],".txt":4,".write":[],".ws":[],".x":[],".y":[],".z":[],"/*":[],"//":[],"/crc":0,"/directives":4,"/docs":4,"/factorytest":0,"/i":0,"/isprime":3,"/ref":4,"/rmt":0,"/roles":4,"/rst":4,"/sketch":0,"0u":[],"0x":[],"0xff":[],"1bc":[],"1f":[],"2a":[],"2ae":[],"2c":[],"2caddr":[],"2d":0,"2dbcce":[],"2dtodispoint":[],"2f":[],"2s":0,"2smicrophone":[],"3d":0,"3dto":[],"3e":[],"5stickcplus":0,":%":[],":/":4,"::":4,":\"":4,"< i":[],"<<":[],">":4,">\"":[],"@python":4,"[bytectr":[],"[cit":4,"[colorpos":[],"[count":[],"[i":[],"[n":[],"[posdata":[],"\")":3,"\",":[3,4],"\"..":4,"\":":4,"\"bat":[],"\\n":3,"\\r":[],"\u3053\u3053":[3,4],"\u3053\u306e":0,"\u305f\u3044":0,"\u3067\u3059":[0,3,4],"\u3068\u3048":0,"\u306a\u308a":0,"\u306e\u3088\u3046":0,"\u307e\u3059":[0,3],"\u3088\u3046":0,"\u30a4\u30f3\u30c8\u30ed\u30c0\u30af\u30b7\u30e7\u30f3intro":2,"\u30bd\u30fc\u30b9\u30b3\u30fc\u30c9":[0,3],"\u30c1\u30e5\u30fc\u30c8\u30ea\u30a2\u30eb":4,"\u30da\u30fc\u30b8":2,"\u30e2\u30b8\u30e5\u30fc\u30eb":2,"\u5834\u5408":0,"\u5f37\u8abf":0,"\u691c\u7d22":2,"\u793a\u3057":[0,3],"\u7d20\u6570":3,"\u7d22\u5f15":2,"])":4,"]+":[],"],":[],"].":[],"];":[],"]=":[],"][":[],"break":[],"byte":[],"case":[],"char":[],"class":4,"const":[],"default":4,"do":[],"double":0,"else":3,"false":[],"float":[],"for":[3,4],"if":[3,4],"in":4,"int":3,"long":4,"new":4,"null":[],"public":[],"return":3,"static":[],"switch":[],"this":4,"true":[],"void":0,"volatile":[],"while":[],"with":4,"{.":[],"{{":[],"||":[],"},":[],"};":[],"}}":[],_acquire:[],_all:[],_alloc:[],_alpha:[],_attr:[],_b:[],_bits:[],_black:[],_ble:[],_block:[],_blue:[],_buf:[],_buff:[],_buffer:[],_callback:[],_carrier:[],_change:[],_channel:[],_clk:[],_comm:[],_config:[],_count:[],_critical:[],_data:[],_delay:[],_destroy:[],_dis:[],_disconnect:[],_display:[],_div:[],_done:[],_driver:[],_duty:[],_en:[],_err:[],_esprite:[],_execute:[],_feb:0,_fft:[],_flag:[],_flags:[],_fmt:[],_format:[],_forward:[],_freq:[],_g:[],_gamma:[],_gpio:[],_green:[],_handle:[],_high:[],_hz:[],_i:[],_idle:[],_in:[],_init:[],_initializer:[],_install:[],_intr:[],_io:[],_ir:[],_isr:[],_item:[],_items:[],_len:[],_level:[],_lock:[],_low:[],_lvl:[],_master:[],_mode:[],_mono:[],_ms:[],_n:[],_new:[],_no:[],_notify:[],_num:[],_ok:[],_out:[],_output:[],_pdm:[],_per:[],_percent:[],_phi:[],_pin:[],_plan:[],_pm:0,_point:0,_pulldown:[],_pwr:[],_r:[],_rand:[],_rate:[],_read:[],_readraw:[],_real:[],_red:[],_release:[],_reset:[],_right:[],_rx:[],_sample:[],_set:[],_source:[],_str:[],_t:0,_theta:[],_timer:[],_timetypedef:[],_tx:[],_type:[],_u:[],_uart:[],_uninstall:[],_unlocked:[],_uuid:[],_white:[],_wifi:[],_write:[],_x:[],_y:[],accx:[],accy:[],accz:[],adc:[],adddescriptor:[],added:4,addr:[],addrcheckbuff:[],addresses:4,admonition:4,adornment:4,after:4,alpha:[],also:4,an:4,analogread:[],and:4,anonymous:4,any:4,arduino:2,are:4,arg:[],as:4,asin:[],at:4,atan:[],attention:4,attribute:4,author:4,auto:4,automatically:4,axp:[],backslash:4,basetype:[],baud:[],be:4,beep:[],beepstate:[],before:4,begin:4,begintransmission:[],between:4,bibliographic:4,bit:[],bits:[],black:[],blank:4,ble:[],blecharacteristic:[],blecharacteristiccallbacks:[],bledevice:0,blename:[],bleserver:0,bleservercallbacks:[],bleservice:[],bleutils:0,block:4,blocks:4,bmp:[],body:2,book:4,bool:[],brackets:4,breaks:4,btna:[],btnb:[],buff:[],buffptr:[],bullet:4,but:4,by:4,bytectr:[],bytesread:[],calculated:[],can:4,cannot:4,caption:4,caution:4,channel:[],chapter:[],character:4,characteristic:[],cheat:2,cheatsheet:4,check:[],checkaxp:[],checkaxppress:[],checki:[],checksum:[],chipid:[],cit:4,citation:4,classifier:4,code:[0,4],color:[],colorbar:[],colorpos:[],comment:4,comments:4,communication:[],compound:4,conclusion:2,connect:[],container:4,contents:[2,4],contexts:4,continuation:4,conversion:4,cos:[],count:[],counter:[],crc:[],create:4,createcharacteristic:[],createserver:[],createservice:[],csv:4,custom:4,da:[],danger:4,data:4,databuff:[],date:4,david:4,decorations:4,def:4,define:[],definition:4,definitions:4,defs:4,delay:[],description:4,deviceconnected:[],digitalread:[],digitalwrite:[],directive:2,directly:4,disbuff:[],disconnect:[],disirsend:[],display:[],displayblesend:[],displaybuff:[],displaygrovesht:[],displaymicro:[],displayrtc:[],displaytestmode:[],divisor:3,dma:[],docinfo:4,docs:4,doctest:4,document:4,docutils:4,drawdisplay:[],drawline:[],driver:0,each:4,efe:[],element:4,elements:2,emphasis:4,empty:4,end:0,endif:[],endtransmission:[],enhancement:4,enumerated:4,epigraph:4,equivalent:4,err:[],error:4,errordialog:[],escapes:4,esp:0,etc:4,even:4,examples:4,explicit:4,extern:[],external:4,fail:[],faild:[],feb:4,fft:0,field:4,figure:4,file:4,find:[],fixed:[],flush:4,footer:4,footnote:4,format:4,free:[],from:4,full:4,generate:4,generates:4,generic:4,getacceldata:[],getadvertising:[],getdata:[],gettempandhum:[],goodger:4,gpio:[],grid:4,hardware:[],header:4,heading:4,here:0,hex:[],high:[],highlights:4,hint:4,hoge:0,html:4,http:4,hum:[],humdata:[],humraw:[],humsave:[],hw:[],hyperlink:4,hz:[],i2s:[],icon:[],image:4,imagedata:[],images:3,important:4,imu:[],include:[0,4],indentation:4,indented:4,indents:4,info:4,informal:4,init:[],initbleserver:[],initi:[],initirtx:[],inline:2,input:[3,4],instead:4,internal:4,internet:4,interpreted:2,intr:[],intro:3,introductory:4,ir:[],iram:[],irtxsem:[],is:[3,4],isprime:3,it:4,items:4,itself:4,labelled:4,last:[],latex:4,lcd:[],least:4,legend:4,len:[],length:[],like:4,line:[0,4],lines:4,list:4,lists:4,literal:4,logical:[],loop:0,m5:[],main:[0,3],make:0,malloc:[],manually:4,many:4,map:[],markup:2,mask:[],math:4,mathematical:4,max:[],memset:[],meta:4,metadata:4,mi:4,micrecordfft:[],microphone:[],min:[],mini:4,mode:[],mpu:[],msb:[],mycallbacks:[],myservercallbacks:[],name:4,named:4,next:4,no:4,non:4,not:3,notation:4,note:4,notify:[],num:3,number:[3,4],numbered:4,numn:[],of:4,olddeviceconnected:[],on:4,once:0,onconnect:[],ondisconnect:[],ontimer:[],onwrite:[],option:4,optional:4,options:4,or:4,output:[],overlined:4,paragraphs:4,parallel:4,parsed:4,passed:4,pcharacteristic:[],pdest:[],pdfalse:[],pep:4,phi:[],pi:[],picture:4,pin:[],pinmode:[],please:4,point:0,portenter:[],portexit:[],portmax:[],portmux:[],porttick:[],posdata:[],possible:4,preceded:4,preserve:4,prime:3,print:4,printf:3,printline:[],processes:4,property:[],proposal:4,prxcharacteristic:[],pserver:[],pservice:[],psrc:[],ptr:[],ptxcharacteristic:[],pull:4,put:0,python:4,quick:2,quote:4,quoted:4,quotes:4,raw:4,read:4,reading:4,real:[],rect:[],recvflag:[],reference:2,reminders:2,repeatedly:0,replace:4,replacement:4,request:4,rest:4,restructuredtext:2,result:3,revision:4,rfc:4,rmt:[],role:2,rom:0,rotatepoint:[],rtc:[],rubric:4,run:0,sample:0,scanf:3,section:2,sections:4,sectnum:4,see:4,semaphorehandle:[],send:[],senddata:[],separate:4,separated:4,serial:[],service:[],set:4,setcallbacks:[],setpower:[],setup:0,setvalue:[],sheet:2,sidebar:4,simple:4,sin:[],size:[],sizeof:[],source:4,spaces:4,specific:4,sprintf:[],sqrt:[],src:0,standalone:4,standard:4,start:0,stdio:3,stereo:[],stop:[],str:[],strbuff:[],string:[],strong:4,struct:0,structure:2,sub:4,subscript:4,subsections:4,substitution:4,successful:[],sup:4,superscript:4,syntax:2,table:4,tables:4,target:4,taskhandle:[],temp:[],tempdata:[],tempraw:[],tempsave:[],term:4,test:[],testmode:[],text:2,tft:[],the:2,theta:[],time:[],timer:[],timeralarmenable:[],timeralarmwrite:[],timerattachinterrupt:[],timerbegin:[],timercount:[],timermux:[],timersemaphore:[],tip:4,title:4,titled:4,titles:4,to:[0,4],today:4,topic:4,tutorial:2,two:4,tx:[],type:4,typedef:0,uint:[],underlined:4,unicode:4,uniform:4,unsigned:[],untouched:4,update:[],use:4,used:4,useful:4,uuid:[],val:[],variation:4,vbat:[],verse:4,version:4,visible:4,vol:[],wait:[],warning:4,way:4,were:4,wire:[],wrapped:4,writer:4,xhandle:[],xhigherprioritytaskwoken:[],xsemaphore:[],xsemaphorecreatebinary:[],xsemaphorecreatemutex:[],xsemaphoregive:[],xsemaphoregivefromisr:[],xsemaphoretake:[],xtaskcreate:[],ydata:[],you:4,your:0},titles:["Arduino","Conclusion","Welcome to TestRTP's documentation!","\u30a4\u30f3\u30c8\u30ed\u30c0\u30af\u30b7\u30e7\u30f3Intro","Tutorial"],titleterms:{"'s":2,"\u30a4\u30f3\u30c8\u30ed\u30c0\u30af\u30b7\u30e7\u30f3intro":3,and:2,arduino:0,body:4,chapter:[],cheat:4,conclusion:1,directive:4,documentation:2,elements:4,indices:2,inline:4,interpreted:4,intro:[],markup:4,quick:4,reference:4,reminders:4,restructuredtext:4,role:4,section:4,sheet:4,structure:4,subsection:[],syntax:4,tables:2,testrtp:2,text:4,the:4,title:[],to:2,tutorial:4,welcome:2}}) \ No newline at end of file diff --git a/_build/html/tutorial.html b/_build/html/tutorial.html index e7b7336..2ceb2ef 100644 --- a/_build/html/tutorial.html +++ b/_build/html/tutorial.html @@ -1,112 +1,564 @@ - - - - - Tutorial — TestRTP ドキュメント - - - - - - - - + + + + + + + + Tutorial — TestRTP ドキュメント + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + - - - - - - - - -
-
-
+
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+

Tutorial

ここはチュートリアルです。

+
+

The reStructuredText Cheat Sheet: Syntax Reminders

+
+
Info
+

See <http://docutils.sf.net/rst.html> for introductory docs.

+
+
Author
+

David Goodger <goodger@python.org>

+
+
Date
+

$Date: 2013-02-20 02:10:53 +0100 (Mi, 20. Feb 2013) $

+
+
Revision
+

$Revision: 7612 $

+
+
Description
+

This is a "docinfo block", or bibliographic field list

+
+
+
+

注釈

+

If you are reading this as HTML, please read +cheatsheet.txt instead to see the input syntax examples!

+
+
+
+
+

Section Structure

+

Section titles are underlined or overlined & underlined.

+
+
+

Body Elements

+

Grid table:

+ ++++ + + + + + + + + + +

Paragraphs are flush-left, +separated by blank lines.

+
+

Block quotes are indented.

+
+

Literal block, preceded by "::":

+
Indented
+
+
+

or:

+
> Quoted
+
+
+
>>> print 'Doctest block'
+Doctest block
+
+
+
+
Line blocks preserve line breaks & indents. [new in 0.3.6]
+
+
Useful for addresses, verse, and adornment-free lists; long +lines can be wrapped with continuation lines.
+
+
+
+

Simple tables:

+ ++++ + + + + + + + + + + + + + + + + + + + + + + +

List Type

Examples (syntax in the text source)

Bullet list

    +

  • items begin with "-", "+", or "*"

    • +
+

Enumerated list

    +

  1. items use any variation of "1.", "A)", and "(i)"

    2. +

  2. also auto-enumerated

    3. +
+

Definition list

+
Term is flush-leftoptional classifier

Definition is indented, no blank line between

+
+
+

Field list

+
field name
+

field body

+
+
+

Option list

+
-o
+

at least 2 spaces between option & description

+
+
+
+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Explicit Markup

Examples (visible in the text source)

Footnote

+
1
+

Manually numbered or [#] auto-numbered +(even [#labelled]) or [*] auto-symbol

+
+
+

Citation

+
CIT2002
+

A citation.

+
+
+

Hyperlink Target

Anonymous Target

Directive ("::")

_images/biohazard.png +

Substitution Def

Comment

Empty Comment

(".." on a line by itself, with blank lines before & after, +used to separate indentation contexts)

+
+
+

Inline Markup

+

emphasis; strong emphasis; interpreted text; interpreted text +with role; inline literal text; standalone hyperlink, +http://docutils.sourceforge.net; named reference, reStructuredText; +anonymous reference; footnote reference, 1; citation reference, +[CIT2002]; like an inline directive; inline internal target.

+
+
+

Directive Quick Reference

+

See <http://docutils.sf.net/docs/ref/rst/directives.html> for full info.

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Directive Name

Description (Docutils version added to, in [brackets])

attention

Specific admonition; also "caution", "danger", +"error", "hint", "important", "note", "tip", "warning"

admonition

Generic titled admonition: .. admonition:: By The Way

image

.. image:: picture.png; many options possible

figure

Like "image", but with optional caption and legend

topic

.. topic:: Title; like a mini section

sidebar

.. sidebar:: Title; like a mini parallel document

parsed-literal

A literal block with parsed inline markup

rubric

.. rubric:: Informal Heading

epigraph

Block quote with class="epigraph"

highlights

Block quote with class="highlights"

pull-quote

Block quote with class="pull-quote"

compound

Compound paragraphs [0.3.6]

container

Generic block-level container element [0.3.10]

table

Create a titled table [0.3.1]

list-table

Create a table from a uniform two-level bullet list [0.3.8]

csv-table

Create a table from CSV data [0.3.4]

contents

Generate a table of contents

sectnum

Automatically number sections, subsections, etc.

header, footer

Create document decorations [0.3.8]

target-notes

Create an explicit footnote for each external target

math

Mathematical notation (input in LaTeX format)

meta

HTML-specific metadata

include

Read an external reST file as if it were inline

raw

Non-reST data passed untouched to the Writer

replace

Replacement text for substitution definitions

unicode

Unicode character code conversion for substitution defs

date

Generates today's date; for substitution defs

class

Set a "class" attribute on the next element

role

Create a custom interpreted text role [0.3.2]

default-role

Set the default interpreted text role [0.3.10]

title

Set the metadata document title [0.3.10]

+
+
+

Interpreted Text Role Quick Reference

+

See <http://docutils.sf.net/docs/ref/rst/roles.html> for full info.

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Role Name

Description

emphasis

Equivalent to emphasis

literal

Equivalent to literal but processes backslash escapes

math

Mathematical notation (input in LaTeX format)

PEP

Reference to a numbered Python Enhancement Proposal

RFC

Reference to a numbered Internet Request For Comments

raw

For non-reST data; cannot be used directly (see docs) [0.3.6]

strong

Equivalent to strong

sub

Subscript

sup

Superscript

title

Title reference (book, etc.); standard default role

+
+
- +
-
+
+ + - - - - -

ナビゲーション

-

Contents:

- - -
-

Related Topics

- -
- - - - - - - - - - -
-
-
-
-
- ©2021, Motoki Miura. - - | - Powered by Sphinx 2.4.0 - & Alabaster 0.7.12 - - | - Page source -
- + + + - - + \ No newline at end of file diff --git a/conf.py b/conf.py index 7d77b65..fba4fa5 100644 --- a/conf.py +++ b/conf.py @@ -28,6 +28,8 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + 'sphinx_copybutton', + 'sphinx_rtd_theme', ] # Add any paths that contain templates here, relative to this directory. @@ -51,9 +53,20 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'alabaster' +# html_theme = 'alabaster' +# html_theme = 'bizstyle' +# html_theme = 'nature' +html_theme = 'sphinx_rtd_theme' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] \ No newline at end of file +html_static_path = ['_static'] + +#latex_docclass = {'manual': 'jsbook'} +latex_engine = 'platex' +#latex_documents = {'documentclass':'howto'} +latex_elements = { + 'papersize': 'a4paper', + 'pointsize': '10pt', + } diff --git a/index.rst b/index.rst index 38f855b..4c18f2d 100644 --- a/index.rst +++ b/index.rst @@ -11,6 +11,7 @@ :caption: Contents: intro + arduino tutorial conclusion diff --git a/intro.rst b/intro.rst index 751b632..e4aaa6a 100644 --- a/intro.rst +++ b/intro.rst @@ -1,6 +1,59 @@ -Intro +イントロダクションIntro =================================== -ここはIntroです。 +ここはIntroです。:ref:`isprime` に、ソースコードの例を示します。 + +.. code-block:: + + #include + + int isprime(int n){ + int i; + for(i=2;i for introductory docs. +:Author: David Goodger +:Date: $Date: 2013-02-20 02:10:53 +0100 (Mi, 20. Feb 2013) $ +:Revision: $Revision: 7612 $ +:Description: This is a "docinfo block", or bibliographic field list + +.. NOTE:: If you are reading this as HTML, please read + ``_ instead to see the input syntax examples! + +Section Structure +================= +Section titles are underlined or overlined & underlined. + +Body Elements +============= +Grid table: + ++--------------------------------+-----------------------------------+ +| Paragraphs are flush-left, | Literal block, preceded by "::":: | +| separated by blank lines. | | +| | Indented | +| Block quotes are indented. | | ++--------------------------------+ or:: | +| >>> print 'Doctest block' | | +| Doctest block | > Quoted | ++--------------------------------+-----------------------------------+ +| | Line blocks preserve line breaks & indents. [new in 0.3.6] | +| | Useful for addresses, verse, and adornment-free lists; long | +| lines can be wrapped with continuation lines. | ++--------------------------------------------------------------------+ + +Simple tables: + +================ ============================================================ +List Type Examples (syntax in the `text source `_) +================ ============================================================ +Bullet list * items begin with "-", "+", or "*" +Enumerated list 1. items use any variation of "1.", "A)", and "(i)" + #. also auto-enumerated +Definition list Term is flush-left : optional classifier + Definition is indented, no blank line between +Field list :field name: field body +Option list -o at least 2 spaces between option & description +================ ============================================================ + +================ ============================================================ +Explicit Markup Examples (visible in the `text source`_) +================ ============================================================ +Footnote .. [1] Manually numbered or [#] auto-numbered + (even [#labelled]) or [*] auto-symbol +Citation .. [CIT2002] A citation. +Hyperlink Target .. _reStructuredText: http://docutils.sf.net/rst.html + .. _indirect target: reStructuredText_ + .. _internal target: +Anonymous Target __ http://docutils.sf.net/docs/ref/rst/restructuredtext.html +Directive ("::") .. image:: images/biohazard.png +Substitution Def .. |substitution| replace:: like an inline directive +Comment .. is anything else +Empty Comment (".." on a line by itself, with blank lines before & after, + used to separate indentation contexts) +================ ============================================================ + +Inline Markup +============= +*emphasis*; **strong emphasis**; `interpreted text`; `interpreted text +with role`:emphasis:; ``inline literal text``; standalone hyperlink, +http://docutils.sourceforge.net; named reference, reStructuredText_; +`anonymous reference`__; footnote reference, [1]_; citation reference, +[CIT2002]_; |substitution|; _`inline internal target`. + +Directive Quick Reference +========================= +See for full info. + +================ ============================================================ +Directive Name Description (Docutils version added to, in [brackets]) +================ ============================================================ +attention Specific admonition; also "caution", "danger", + "error", "hint", "important", "note", "tip", "warning" +admonition Generic titled admonition: ``.. admonition:: By The Way`` +image ``.. image:: picture.png``; many options possible +figure Like "image", but with optional caption and legend +topic ``.. topic:: Title``; like a mini section +sidebar ``.. sidebar:: Title``; like a mini parallel document +parsed-literal A literal block with parsed inline markup +rubric ``.. rubric:: Informal Heading`` +epigraph Block quote with class="epigraph" +highlights Block quote with class="highlights" +pull-quote Block quote with class="pull-quote" +compound Compound paragraphs [0.3.6] +container Generic block-level container element [0.3.10] +table Create a titled table [0.3.1] +list-table Create a table from a uniform two-level bullet list [0.3.8] +csv-table Create a table from CSV data [0.3.4] +contents Generate a table of contents +sectnum Automatically number sections, subsections, etc. +header, footer Create document decorations [0.3.8] +target-notes Create an explicit footnote for each external target +math Mathematical notation (input in LaTeX format) +meta HTML-specific metadata +include Read an external reST file as if it were inline +raw Non-reST data passed untouched to the Writer +replace Replacement text for substitution definitions +unicode Unicode character code conversion for substitution defs +date Generates today's date; for substitution defs +class Set a "class" attribute on the next element +role Create a custom interpreted text role [0.3.2] +default-role Set the default interpreted text role [0.3.10] +title Set the metadata document title [0.3.10] +================ ============================================================ + +Interpreted Text Role Quick Reference +===================================== +See for full info. + +================ ============================================================ +Role Name Description +================ ============================================================ +emphasis Equivalent to *emphasis* +literal Equivalent to ``literal`` but processes backslash escapes +math Mathematical notation (input in LaTeX format) +PEP Reference to a numbered Python Enhancement Proposal +RFC Reference to a numbered Internet Request For Comments +raw For non-reST data; cannot be used directly (see docs) [0.3.6] +strong Equivalent to **strong** +sub Subscript +sup Superscript +title Title reference (book, etc.); standard default role +================ ============================================================ +