cdocutils.nodes document q)q}q(U nametypesq}q(XplantumlqXsphinxqXabout these documentsqNXrestructuredtext bundleq Xrst2pdfq Xrestructuredtextq Xediting contentq NXgraphvizq Xbuilt out versionqXjeditqX setuptoolsqXtextmateqXxlrdqXsetting up a build environmentqNXbuilding the documentationqNuUsubstitution_defsq}qUparse_messagesq]qcdocutils.nodes system_message q)q}q(U rawsourceqUUparentqcdocutils.nodes section q)q}q (hUhh)q!}q"(hUhh)q#}q$(hUhhUsourceq%XZ/var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/about.txtq&Utagnameq'Usectionq(U attributesq)}q*(Udupnamesq+]Uclassesq,]Ubackrefsq-]Uidsq.]q/Uabout-these-documentsq0aUnamesq1]q2hauUlineq3KUdocumentq4hUchildrenq5]q6(cdocutils.nodes title q7)q8}q9(hXAbout These Documentsq:hh#h%h&h'Utitleq;h)}q<(h+]h,]h-]h.]h1]uh3Kh4hh5]q=cdocutils.nodes Text q>XAbout These Documentsq?q@}qA(hh:hh8ubaubcdocutils.nodes paragraph qB)qC}qD(hXThese documents are generated using Sphinx_ for the overall document processing and generation, and PlantUML_ for most of the UML diagrams.hh#h%h&h'U paragraphqEh)}qF(h+]h,]h-]h.]h1]uh3Kh4hh5]qG(h>X$These documents are generated using qHqI}qJ(hX$These documents are generated using hhCubcdocutils.nodes reference qK)qL}qM(hXSphinx_UresolvedqNKhhCh'U referenceqOh)}qP(UnameXSphinxUrefuriqQXhttp://sphinx.pocoo.org/qRh.]h-]h+]h,]h1]uh5]qSh>XSphinxqTqU}qV(hUhhLubaubh>X9 for the overall document processing and generation, and qWqX}qY(hX9 for the overall document processing and generation, and hhCubhK)qZ}q[(hX PlantUML_hNKhhCh'hOh)}q\(UnameXPlantUMLhQXhttp://plantuml.sourceforge.netq]h.]h-]h+]h,]h1]uh5]q^h>XPlantUMLq_q`}qa(hUhhZubaubh>X for most of the UML diagrams.qbqc}qd(hX for most of the UML diagrams.hhCubeubh)qe}qf(hUhh#h%h&h'h(h)}qg(h+]h,]h-]h.]qhUediting-contentqiah1]qjh auh3K h4hh5]qk(h7)ql}qm(hXEditing Contentqnhheh%h&h'h;h)}qo(h+]h,]h-]h.]h1]uh3K h4hh5]qph>XEditing Contentqqqr}qs(hhnhhlubaubhB)qt}qu(hXAll of these documents are formatted in reStructuredText_, formatted plain text that is similar to the plain text formatting used in wiki pages. The formatting guidelines for Sphinx are available at http://sphinx.pocoo.org/contents.htmlhheh%h&h'hEh)}qv(h+]h,]h-]h.]h1]uh3K h4hh5]qw(h>X(All of these documents are formatted in qxqy}qz(hX(All of these documents are formatted in hhtubhK)q{}q|(hXreStructuredText_hNKhhth'hOh)}q}(UnameXreStructuredTexthQX;http://docutils.sourceforge.net/docs/user/rst/quickref.htmlq~h.]h-]h+]h,]h1]uh5]qh>XreStructuredTextqq}q(hUhh{ubaubh>X, formatted plain text that is similar to the plain text formatting used in wiki pages. The formatting guidelines for Sphinx are available at qq}q(hX, formatted plain text that is similar to the plain text formatting used in wiki pages. The formatting guidelines for Sphinx are available at hhtubhK)q}q(hX%http://sphinx.pocoo.org/contents.htmlqh)}q(Urefurihh.]h-]h+]h,]h1]uhhth5]qh>X%http://sphinx.pocoo.org/contents.htmlqq}q(hUhhubah'hOubeubhB)q}q(hX\Portions of content, specifically all the individual function and exception descriptions, are maintained in an Excel spreadsheet (best edited using OpenOffice Calc). The reStructuredText_ descriptions of the methods and exceptions is generated by processing the content in the spreadsheet with a python script "ihwd.py" located in the tools folder.hheh%h&h'hEh)}q(h+]h,]h-]h.]h1]uh3Kh4hh5]q(h>XPortions of content, specifically all the individual function and exception descriptions, are maintained in an Excel spreadsheet (best edited using OpenOffice Calc). The qq}q(hXPortions of content, specifically all the individual function and exception descriptions, are maintained in an Excel spreadsheet (best edited using OpenOffice Calc). The hhubhK)q}q(hXreStructuredText_hNKhhh'hOh)}q(UnameXreStructuredTexthQh~h.]h-]h+]h,]h1]uh5]qh>XreStructuredTextqq}q(hUhhubaubh>X descriptions of the methods and exceptions is generated by processing the content in the spreadsheet with a python script "ihwd.py" located in the tools folder.qq}q(hX descriptions of the methods and exceptions is generated by processing the content in the spreadsheet with a python script "ihwd.py" located in the tools folder.hhubeubhB)q}q(hXAll content should be saved as UTF-8 encoded text using UNIX® style new lines. White space and indentation is part of the formatting for reStructuredText. Please be consistent with the use of soft tabs (2 spaces per tab).qhheh%h&h'hEh)}q(h+]h,]h-]h.]h1]uh3Kh4hh5]qh>XAll content should be saved as UTF-8 encoded text using UNIX® style new lines. White space and indentation is part of the formatting for reStructuredText. Please be consistent with the use of soft tabs (2 spaces per tab).qq}q(hhhhubaubhB)q}q(hXreStructuredText_ can be edited with any plain text editor. These documents have been edited mainly with TextMate_ on OS X, which offers a preview feature when the `reStructuredText bundle`_ is installed. Other editors that work well for editing reStructuredText_ are jEdit and Komodo Edit. There are also various plugins available for editors to assist with reStructuredText formatting.hheh%h&h'hEh)}q(h+]h,]h-]h.]h1]uh3Kh4hh5]q(hK)q}q(hXreStructuredText_hNKhhh'hOh)}q(UnameXreStructuredTexthQh~h.]h-]h+]h,]h1]uh5]qh>XreStructuredTextqq}q(hUhhubaubh>XX can be edited with any plain text editor. These documents have been edited mainly with qq}q(hXX can be edited with any plain text editor. These documents have been edited mainly with hhubhK)q}q(hX TextMate_hNKhhh'hOh)}q(UnameXTextMatehQXhttp://macromates.com/qh.]h-]h+]h,]h1]uh5]qh>XTextMateqq}q(hUhhubaubh>X2 on OS X, which offers a preview feature when the qq}q(hX2 on OS X, which offers a preview feature when the hhubhK)q}q(hX`reStructuredText bundle`_hNKhhh'hOh)}q(UnameXreStructuredText bundlehQX5https://github.com/textmate/restructuredtext.tmbundleqh.]h-]h+]h,]h1]uh5]qh>XreStructuredText bundleqŅq}q(hUhhubaubh>X8 is installed. Other editors that work well for editing qȅq}q(hX8 is installed. Other editors that work well for editing hhubhK)q}q(hXreStructuredText_hNKhhh'hOh)}q(UnameXreStructuredTexthQh~h.]h-]h+]h,]h1]uh5]qh>XreStructuredTextqυq}q(hUhhubaubh>X| are jEdit and Komodo Edit. There are also various plugins available for editors to assist with reStructuredText formatting.q҅q}q(hX| are jEdit and Komodo Edit. There are also various plugins available for editors to assist with reStructuredText formatting.hhubeubhB)q}q(hXFollow the normal procedures for working with the subversion repository. After checking in, your edits should appear in the `built out version`_ of the docs within five minutes.hheh%h&h'hEh)}q(h+]h,]h-]h.]h1]uh3K!h4hh5]q(h>X|Follow the normal procedures for working with the subversion repository. After checking in, your edits should appear in the qمq}q(hX|Follow the normal procedures for working with the subversion repository. After checking in, your edits should appear in the hhubhK)q}q(hX`built out version`_hNKhhh'hOh)}q(UnameXbuilt out versionhQX$http://129.24.0.15/ArchitectureDocs/qh.]h-]h+]h,]h1]uh5]qh>Xbuilt out versionqᅁq}q(hUhhubaubh>X! of the docs within five minutes.q䅁q}q(hX! of the docs within five minutes.hhubeubhB)q}q(hXKThe convention for different levels of heading used in these documents is::qhheh%h&h'hEh)}q(h+]h,]h-]h.]h1]uh3K%h4hh5]qh>XJThe convention for different levels of heading used in these documents is:q셁q}q(hXJThe convention for different levels of heading used in these documents is:hhubaubcdocutils.nodes literal_block q)q}q(hX3=== Level 1 --- Level 2 ~~~ Level 3 ... Level 4hheh%h&h'U literal_blockqh)}q(U xml:spaceqUpreserveqh.]h-]h+]h,]h1]uh3K'h4hh5]qh>X3=== Level 1 --- Level 2 ~~~ Level 3 ... Level 4qq}q(hUhhubaubeubh!eubh%h&h'h(h)}q(h+]h,]h-]h.]qUbuilding-the-documentationqah1]qhauh3K.h4hh5]q(h7)q}r(hXBuilding the Documentationrhh!h%h&h'h;h)}r(h+]h,]h-]h.]h1]uh3K.h4hh5]rh>XBuilding the Documentationrr}r(hjhhubaubhB)r}r(hXSphinx_ is required to build the design documents from the source. A couple of Sphinx extensions are included with the subversion checkout of these documents (in ``tools/docutils/rst_directives``). Portions of Sphinx and the PlantUML_ extension have a dependency of Graphviz_, and this will need to be installed in order to build the documents. The rst2pdf_ library is required to build the pdf version of the documents.hh!h%h&h'hEh)}r (h+]h,]h-]h.]h1]uh3K0h4hh5]r (hK)r }r (hXSphinx_hNKhjh'hOh)}r (UnameXSphinxhQhRh.]h-]h+]h,]h1]uh5]rh>XSphinxrr}r(hUhj ubaubh>X is required to build the design documents from the source. A couple of Sphinx extensions are included with the subversion checkout of these documents (in rr}r(hX is required to build the design documents from the source. A couple of Sphinx extensions are included with the subversion checkout of these documents (in hjubcdocutils.nodes literal r)r}r(hX!``tools/docutils/rst_directives``h)}r(h+]h,]h-]h.]h1]uhjh5]rh>Xtools/docutils/rst_directivesrr}r(hUhjubah'Uliteralrubh>X). Portions of Sphinx and the rr}r (hX). Portions of Sphinx and the hjubhK)r!}r"(hX PlantUML_hNKhjh'hOh)}r#(UnameXPlantUMLhQh]h.]h-]h+]h,]h1]uh5]r$h>XPlantUMLr%r&}r'(hUhj!ubaubh>X extension have a dependency of r(r)}r*(hX extension have a dependency of hjubhK)r+}r,(hX Graphviz_hNKhjh'hOh)}r-(UnameXGraphvizhQXhttp://www.graphviz.org/r.h.]h-]h+]h,]h1]uh5]r/h>XGraphvizr0r1}r2(hUhj+ubaubh>XJ, and this will need to be installed in order to build the documents. The r3r4}r5(hXJ, and this will need to be installed in order to build the documents. The hjubhK)r6}r7(hXrst2pdf_hNKhjh'hOh)}r8(UnameXrst2pdfr9hQX!http://code.google.com/p/rst2pdf/r:h.]h-]h+]h,]h1]uh5]r;h>Xrst2pdfr<r=}r>(hUhj6ubaubh>X? library is required to build the pdf version of the documents.r?r@}rA(hX? library is required to build the pdf version of the documents.hjubeubheubh%h&h'h(h)}rB(h+]h,]h-]h.]rCUsetting-up-a-build-environmentrDah1]rEhauh3K7h4hh5]rF(h7)rG}rH(hXSetting up a Build EnvironmentrIhhh%h&h'h;h)}rJ(h+]h,]h-]h.]h1]uh3K7h4hh5]rKh>XSetting up a Build EnvironmentrLrM}rN(hjIhjGubaubhB)rO}rP(hXThe following general instructions apply for Ubuntu linux. Adjust the commands as necessary for your OS (and please update these docs to help others in the process). It is assumed that Python >= 2.6 and Java are available.rQhhh%h&h'hEh)}rR(h+]h,]h-]h.]h1]uh3K9h4hh5]rSh>XThe following general instructions apply for Ubuntu linux. Adjust the commands as necessary for your OS (and please update these docs to help others in the process). It is assumed that Python >= 2.6 and Java are available.rTrU}rV(hjQhjOubaubcdocutils.nodes enumerated_list rW)rX}rY(hUhhh%h&h'Uenumerated_listrZh)}r[(Usuffixr\U.h.]h-]h+]Uprefixr]Uh,]h1]Uenumtyper^Uarabicr_uh3K=h4hh5]r`(cdocutils.nodes list_item ra)rb}rc(hX6Install graphviz:: $ sudo apt-get install graphviz hjXh%h&h'U list_itemrdh)}re(h+]h,]h-]h.]h1]uh3Nh4hh5]rf(hB)rg}rh(hXInstall graphviz::hjbh%h&h'hEh)}ri(h+]h,]h-]h.]h1]uh3K=h5]rjh>XInstall graphviz:rkrl}rm(hXInstall graphviz:hjgubaubh)rn}ro(hX$ sudo apt-get install graphvizhjbh'hh)}rp(hhh.]h-]h+]h,]h1]uh3K?h5]rqh>X$ sudo apt-get install graphvizrrrs}rt(hUhjnubaubeubja)ru}rv(hXCInstall Sphinx (latest version):: $ sudo easy_install -U Sphinx hjXh%h&h'jdh)}rw(h+]h,]h-]h.]h1]uh3Nh4hh5]rx(hB)ry}rz(hX!Install Sphinx (latest version)::hjuh%h&h'hEh)}r{(h+]h,]h-]h.]h1]uh3KAh5]r|h>X Install Sphinx (latest version):r}r~}r(hX Install Sphinx (latest version):hjyubaubh)r}r(hX$ sudo easy_install -U Sphinxhjuh'hh)}r(hhh.]h-]h+]h,]h1]uh3KCh5]rh>X$ sudo easy_install -U Sphinxrr}r(hUhjubaubeubja)r}r(hX?(Optional) Install rst2pdf:: $ sudo easy_install -U rst2pdf hjXh%h&h'jdh)}r(h+]h,]h-]h.]h1]uh3Nh4hh5]r(hB)r}r(hX(Optional) Install rst2pdf::hjh%h&h'hEh)}r(h+]h,]h-]h.]h1]uh3KEh5]rh>X(Optional) Install rst2pdf:rr}r(hX(Optional) Install rst2pdf:hjubaubh)r}r(hX$ sudo easy_install -U rst2pdfhjh'hh)}r(hhh.]h-]h+]h,]h1]uh3KGh5]rh>X$ sudo easy_install -U rst2pdfrr}r(hUhjubaubeubja)r}r(hX(Optional) Edits to the method descriptions in the excel spreadsheet (``MethodCrossReference.xls``) require regeneration of some portions of the documentation, which requires a couple of Python libraries (xlrd and xlwt):: $ sudo easy_install xlrd xlwt hjXh%h&h'jdh)}r(h+]h,]h-]h.]h1]uh3Nh4hh5]r(hB)r}r(hX(Optional) Edits to the method descriptions in the excel spreadsheet (``MethodCrossReference.xls``) require regeneration of some portions of the documentation, which requires a couple of Python libraries (xlrd and xlwt)::hjh%h&h'hEh)}r(h+]h,]h-]h.]h1]uh3KIh5]r(h>XF(Optional) Edits to the method descriptions in the excel spreadsheet (rr}r(hXF(Optional) Edits to the method descriptions in the excel spreadsheet (hjubj)r}r(hX``MethodCrossReference.xls``h)}r(h+]h,]h-]h.]h1]uhjh5]rh>XMethodCrossReference.xlsrr}r(hUhjubah'jubh>Xz) require regeneration of some portions of the documentation, which requires a couple of Python libraries (xlrd and xlwt):rr}r(hXz) require regeneration of some portions of the documentation, which requires a couple of Python libraries (xlrd and xlwt):hjubeubh)r}r(hX$ sudo easy_install xlrd xlwthjh'hh)}r(hhh.]h-]h+]h,]h1]uh3KMh5]rh>X$ sudo easy_install xlrd xlwtrr}r(hUhjubaubeubja)r}r(hXCheckout a copy of the documentation from subversion:: $ svn co https://repository.dataone.org/documents/Projects/cicore/architecture/api-documentation hjXh%h&h'jdh)}r(h+]h,]h-]h.]h1]uh3Nh4hh5]r(hB)r}r(hX6Checkout a copy of the documentation from subversion::hjh%h&h'hEh)}r(h+]h,]h-]h.]h1]uh3KPh5]rh>X5Checkout a copy of the documentation from subversion:rr}r(hX5Checkout a copy of the documentation from subversion:hjubaubh)r}r(hX`$ svn co https://repository.dataone.org/documents/Projects/cicore/architecture/api-documentationhjh'hh)}r(hhh.]h-]h+]h,]h1]uh3KRh5]rh>X`$ svn co https://repository.dataone.org/documents/Projects/cicore/architecture/api-documentationrr}r(hUhjubaubeubja)r}r(hXBuild the documents:: $ cd api-documentation $ make html The documents will be available in ``build/html``, with ``index.html`` being the root document. hjXh%h&h'jdh)}r(h+]h,]h-]h.]h1]uh3Nh4hh5]r(hB)r}r(hXBuild the documents::hjh%h&h'hEh)}r(h+]h,]h-]h.]h1]uh3KUh5]rh>XBuild the documents:rr}r(hXBuild the documents:hjubaubh)r}r(hX"$ cd api-documentation $ make htmlhjh'hh)}r(hhh.]h-]h+]h,]h1]uh3KWh5]rh>X"$ cd api-documentation $ make htmlrr}r(hUhjubaubhB)r}r(hX_The documents will be available in ``build/html``, with ``index.html`` being the root document.hjh%h&h'hEh)}r(h+]h,]h-]h.]h1]uh3KZh5]r(h>X#The documents will be available in rr}r(hX#The documents will be available in hjubj)r}r(hX``build/html``h)}r(h+]h,]h-]h.]h1]uhjh5]rh>X build/htmlrr}r(hUhjubah'jubh>X, with rr}r(hX, with hjubj)r}r(hX``index.html``h)}r(h+]h,]h-]h.]h1]uhjh5]rh>X index.htmlrr}r(hUhjubah'jubh>X being the root document.rr}r(hX being the root document.hjubeubeubeubcdocutils.nodes bullet_list r)r}r(hUhhh%h&h'U bullet_listrh)}r(UbulletrX*h.]h-]h+]h,]h1]uh3K\h4hh5]r(ja)r}r(hXIf changes are made to ``MethodCrossReference.xls``, then an additional make step is required:: $ cd api-documentation $ make generate $ make html hjh%h&h'jdh)}r(h+]h,]h-]h.]h1]uh3Nh4hh5]r(hB)r}r(hX_If changes are made to ``MethodCrossReference.xls``, then an additional make step is required::hjh%h&h'hEh)}r(h+]h,]h-]h.]h1]uh3K\h5]r(h>XIf changes are made to rr}r(hXIf changes are made to hjubj)r}r(hX``MethodCrossReference.xls``h)}r(h+]h,]h-]h.]h1]uhjh5]r h>XMethodCrossReference.xlsr r }r (hUhjubah'jubh>X+, then an additional make step is required:r r}r(hX+, then an additional make step is required:hjubeubh)r}r(hX2$ cd api-documentation $ make generate $ make htmlhjh'hh)}r(hhh.]h-]h+]h,]h1]uh3K_h5]rh>X2$ cd api-documentation $ make generate $ make htmlrr}r(hUhjubaubeubja)r}r(hXIf changes to plantuml diagrams have been made then it will be necessary to regenerate the associated .png images. This can be done using *make*:: $ cd api-documentation $ make plantuml $ make html The plantuml diagram generation can take a while. There are three sub-tasks for *make*, plantuml_source, plantuml_usecase, and plantuml_types which can be used to build diagrams under the *source/design*, *source/design/UseCases*, or *source/apis* folders respectively. hjh%h&h'jdh)}r(h+]h,]h-]h.]h1]uh3Nh4hh5]r(hB)r}r(hXIf changes to plantuml diagrams have been made then it will be necessary to regenerate the associated .png images. This can be done using *make*::hjh%h&h'hEh)}r(h+]h,]h-]h.]h1]uh3Kch5]r(h>XIf changes to plantuml diagrams have been made then it will be necessary to regenerate the associated .png images. This can be done using rr }r!(hXIf changes to plantuml diagrams have been made then it will be necessary to regenerate the associated .png images. This can be done using hjubcdocutils.nodes emphasis r")r#}r$(hX*make*h)}r%(h+]h,]h-]h.]h1]uhjh5]r&h>Xmaker'r(}r)(hUhj#ubah'Uemphasisr*ubh>X:r+}r,(hX:hjubeubh)r-}r.(hX2$ cd api-documentation $ make plantuml $ make htmlhjh'hh)}r/(hhh.]h-]h+]h,]h1]uh3Kfh5]r0h>X2$ cd api-documentation $ make plantuml $ make htmlr1r2}r3(hUhj-ubaubhB)r4}r5(hX The plantuml diagram generation can take a while. There are three sub-tasks for *make*, plantuml_source, plantuml_usecase, and plantuml_types which can be used to build diagrams under the *source/design*, *source/design/UseCases*, or *source/apis* folders respectively.hjh%h&h'hEh)}r6(h+]h,]h-]h.]h1]uh3Kjh5]r7(h>XPThe plantuml diagram generation can take a while. There are three sub-tasks for r8r9}r:(hXPThe plantuml diagram generation can take a while. There are three sub-tasks for hj4ubj")r;}r<(hX*make*h)}r=(h+]h,]h-]h.]h1]uhj4h5]r>h>Xmaker?r@}rA(hUhj;ubah'j*ubh>Xf, plantuml_source, plantuml_usecase, and plantuml_types which can be used to build diagrams under the rBrC}rD(hXf, plantuml_source, plantuml_usecase, and plantuml_types which can be used to build diagrams under the hj4ubj")rE}rF(hX*source/design*h)}rG(h+]h,]h-]h.]h1]uhj4h5]rHh>X source/designrIrJ}rK(hUhjEubah'j*ubh>X, rLrM}rN(hX, hj4ubj")rO}rP(hX*source/design/UseCases*h)}rQ(h+]h,]h-]h.]h1]uhj4h5]rRh>Xsource/design/UseCasesrSrT}rU(hUhjOubah'j*ubh>X, or rVrW}rX(hX, or hj4ubj")rY}rZ(hX *source/apis*h)}r[(h+]h,]h-]h.]h1]uhj4h5]r\h>X source/apisr]r^}r_(hUhjYubah'j*ubh>X folders respectively.r`ra}rb(hX folders respectively.hj4ubeubeubeubjW)rc}rd(hUhhh%h&h'jZh)}re(j\U.UstartrfKh.]h-]h+]j]Uh,]h1]j^j_uh3Koh4hh5]rg(ja)rh}ri(hXTo build a PDF version of the documents.:: $ make pdf Note that the PDF generator can be quite fickle, and may require some tweaking to work. hjch%h&h'jdh)}rj(h+]h,]h-]h.]h1]uh3Nh4hh5]rk(hB)rl}rm(hX*To build a PDF version of the documents.::hjhh%h&h'hEh)}rn(h+]h,]h-]h.]h1]uh3Koh5]roh>X)To build a PDF version of the documents.:rprq}rr(hX)To build a PDF version of the documents.:hjlubaubh)rs}rt(hX $ make pdfhjhh'hh)}ru(hhh.]h-]h+]h,]h1]uh3Kqh5]rvh>X $ make pdfrwrx}ry(hUhjsubaubhB)rz}r{(hXWNote that the PDF generator can be quite fickle, and may require some tweaking to work.r|hjhh%h&h'hEh)}r}(h+]h,]h-]h.]h1]uh3Ksh5]r~h>XWNote that the PDF generator can be quite fickle, and may require some tweaking to work.rr}r(hj|hjzubaubeubja)r}r(hX=To build an ePub version of the documents:: $ make epub hjch%h&h'jdh)}r(h+]h,]h-]h.]h1]uh3Nh4hh5]r(hB)r}r(hX+To build an ePub version of the documents::rhjh%h&h'hEh)}r(h+]h,]h-]h.]h1]uh3Kuh5]rh>X*To build an ePub version of the documents:rr}r(hX*To build an ePub version of the documents:hjubaubh)r}r(hX $ make epubhjh'hh)}r(hhh.]h-]h+]h,]h1]uh3Kwh5]rh>X $ make epubrr}r(hUhjubaubeubeubcdocutils.nodes target r)r}r(hX&.. _Graphviz: http://www.graphviz.org/U referencedrKhhh%h&h'Utargetrh)}r(hQj.h.]rUgraphvizrah-]h+]h,]h1]rh auh3K{h4hh5]ubj)r}r(hX$.. _Sphinx: http://sphinx.pocoo.org/jKhhh%h&h'jh)}r(hQhRh.]rUsphinxrah-]h+]h,]h1]rhauh3K}h4hh5]ubj)r}r(hX-.. _PlantUML: http://plantuml.sourceforge.netjKhhh%h&h'jh)}r(hQh]h.]rUplantumlrah-]h+]h,]h1]rhauh3Kh4hh5]ubj)r}r(hX*.. _xlrd: http://pypi.python.org/pypi/xlrdhhh%h&h'jh)}r(hQX http://pypi.python.org/pypi/xlrdh.]rUxlrdrah-]h+]h,]h1]rhauh3Kh4hh5]ubj)r}r(hX6.. _setuptools: http://pypi.python.org/pypi/setuptoolshhh%h&h'jh)}r(hQX&http://pypi.python.org/pypi/setuptoolsh.]rU setuptoolsrah-]h+]h,]h1]rhauh3Kh4hh5]ubj)r}r(hX... _rst2pdf: http://code.google.com/p/rst2pdf/jKhhh%h&h'jh)}r(hQj:h.]rUrst2pdfrah-]h+]h,]h1]rh auh3Kh4hh5]ubj)r}r(hX;.. _built out version: http://129.24.0.15/ArchitectureDocs/jKhhh%h&h'jh)}r(hQhh.]rUbuilt-out-versionrah-]h+]h,]h1]rhauh3Kh4hh5]ubj)r}r(hX$.. _TextMate: http://macromates.com/jKhhh%h&h'jh)}r(hQhh.]rUtextmaterah-]h+]h,]h1]rhauh3Kh4hh5]ubj)r}r(hXR.. _reStructuredText bundle: https://github.com/textmate/restructuredtext.tmbundlejKhhh%h&h'jh)}r(hQhh.]rUrestructuredtext-bundlerah-]h+]h,]h1]rh auh3Kh4hh5]ubj)r}r(hX .. _jEdit: http://www.jedit.org/hhh%h&h'jh)}r(hQXhttp://www.jedit.org/h.]rUjeditrah-]h+]h,]h1]rhauh3Kh4hh5]ubj)r}r(hXQ.. _reStructuredText: http://docutils.sourceforge.net/docs/user/rst/quickref.htmljKhhh%h&h'jh)}r(hQh~h.]rUrestructuredtextrah-]h+]h,]h1]rh auh3Kh4hh5]ubeubh%h&h'Usystem_messagerh)}r(h+]UlevelKh.]h-]Usourceh&h,]h1]UlineKUtypeUINFOruh3Koh4hh5]rhB)r}r(hX:Enumerated list start value not ordinal-1: "7" (ordinal 7)h)}r(h+]h,]h-]h.]h1]uhhh5]rh>X:Enumerated list start value not ordinal-1: "7" (ordinal 7)rr}r(hUhjubah'hEubaubaUcurrent_sourcerNU decorationrNUautofootnote_startrKUnameidsr}r(hjhjhh0h jh jh jh hih jhjhjhjhjhjhjDhhuh5]rh#ahUU transformerrNU footnote_refsr}rUrefnamesr}r(Xplantuml]r(hZj!eXsphinx]r(hLj eXrestructuredtext bundle]rhaXrestructuredtext]r(h{hhhej9]rj6aXgraphviz]rj+aXbuilt out version]rhaXtextmate]rhauUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rh4hU current_linerNUtransform_messagesr]r(h)r}r(hUh)}r(h+]UlevelKh.]h-]Usourceh&h,]h1]UlineKUtypejuh5]rhB)r}r(hUh)}r (h+]h,]h-]h.]h1]uhjh5]r h>X*Hyperlink target "xlrd" is not referenced.r r }r (hUhjubah'hEubah'jubh)r}r(hUh)}r(h+]UlevelKh.]h-]Usourceh&h,]h1]UlineKUtypejuh5]rhB)r}r(hUh)}r(h+]h,]h-]h.]h1]uhjh5]rh>X0Hyperlink target "setuptools" is not referenced.rr}r(hUhjubah'hEubah'jubh)r}r(hUh)}r(h+]UlevelKh.]h-]Usourceh&h,]h1]UlineKUtypejuh5]rhB)r}r(hUh)}r(h+]h,]h-]h.]h1]uhjh5]r h>X+Hyperlink target "jedit" is not referenced.r!r"}r#(hUhjubah'hEubah'jubeUreporterr$NUid_startr%KU autofootnotesr&]r'U citation_refsr(}r)Uindirect_targetsr*]r+Usettingsr,(cdocutils.frontend Values r-or.}r/(Ufootnote_backlinksr0KUrecord_dependenciesr1NU rfc_base_urlr2Uhttps://tools.ietf.org/html/r3U tracebackr4Upep_referencesr5NUstrip_commentsr6NU toc_backlinksr7Uentryr8U language_coder9Uenr:U datestampr;NU report_levelr<KU _destinationr=NU halt_levelr>KU strip_classesr?Nh;NUerror_encoding_error_handlerr@UbackslashreplacerAUdebugrBNUembed_stylesheetrCUoutput_encoding_error_handlerrDUstrictrEU sectnum_xformrFKUdump_transformsrGNU docinfo_xformrHKUwarning_streamrINUpep_file_url_templaterJUpep-%04drKUexit_status_levelrLKUconfigrMNUstrict_visitorrNNUcloak_email_addressesrOUtrim_footnote_reference_spacerPUenvrQNUdump_pseudo_xmlrRNUexpose_internalsrSNUsectsubtitle_xformrTU source_linkrUNUrfc_referencesrVNUoutput_encodingrWUutf-8rXU source_urlrYNUinput_encodingrZU utf-8-sigr[U_disable_configr\NU id_prefixr]UU tab_widthr^KUerror_encodingr_UUTF-8r`U_sourcerah&Ugettext_compactrbU generatorrcNUdump_internalsrdNU smart_quotesreU pep_base_urlrfU https://www.python.org/dev/peps/rgUsyntax_highlightrhUlongriUinput_encoding_error_handlerrjjEUauto_id_prefixrkUidrlUdoctitle_xformrmUstrip_elements_with_classesrnNU _config_filesro]Ufile_insertion_enabledrpU raw_enabledrqKU dump_settingsrrNubUsymbol_footnote_startrsKUidsrt}ru(hh!jjjjjDhjjjjh0h#jjjjjjjjjjjjjjhiheuUsubstitution_namesrv}rwh'h4h)}rx(h+]h.]h-]Usourceh&h,]h1]uU footnotesry]rzUrefidsr{}r|ub.