Äcdocutils.nodes
document
q)Åq}q(U	nametypesq}q(X���plantumlqàX���sphinxqàX���about these documentsqNX���restructuredtext bundleq	àX���rst2pdfq
àX���restructuredtextqàX���editing contentqNX���graphvizq
àX���built out versionqàX���jeditqàX
���setuptoolsqàX���textmateqàX���xlrdqàX���setting up a build environmentqNX���building the documentationqNuUsubstitution_defsq}qUparse_messagesq]qcdocutils.nodes
system_message
q)Åq}q(U	rawsourceqU�Uparentqcdocutils.nodes
section
q)Åq}q (hU�hh)Åq!}q"(hU�hh)Åq#}q$(hU�hhUsourceq%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(hX���About These Documentsq:hh#h%h&h'Utitleq;h)}q<(h+]h,]h-]h.]h1]uh3Kh4hh5]q=cdocutils.nodes
Text
q>X���About These Documentsq?ÖÅq@}qA(hh:hh8ubaubcdocutils.nodes
paragraph
qB)ÅqC}qD(hXã���These 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 qHÖÅqI}qJ(hX$���These documents are generated using hhCubcdocutils.nodes
reference
qK)ÅqL}qM(hX���Sphinx_UresolvedqNKhhCh'U	referenceqOh)}qP(UnameX���SphinxUrefuriqQX���http://sphinx.pocoo.org/qRh.]h-]h+]h,]h1]uh5]qSh>X���SphinxqTÖÅqU}qV(hU�hhLubaubh>X9��� for the overall document
processing and generation, and qWÖÅqX}qY(hX9��� for the overall document
processing and generation, and hhCubhK)ÅqZ}q[(hX	���PlantUML_hNKhhCh'hOh)}q\(UnameX���PlantUMLhQX���http://plantuml.sourceforge.netq]h.]h-]h+]h,]h1]uh5]q^h>X���PlantUMLq_ÖÅq`}qa(hU�hhZubaubh>X��� for most of the UML diagrams.qbÖÅqc}qd(hX��� for most of the UML diagrams.hhCubeubh)Åqe}qf(hU�hh#h%h&h'h(h)}qg(h+]h,]h-]h.]qhUediting-contentqiah1]qjhauh3K	h4hh5]qk(h7)Åql}qm(hX���Editing Contentqnhheh%h&h'h;h)}qo(h+]h,]h-]h.]h1]uh3K	h4hh5]qph>X���Editing ContentqqÖÅqr}qs(hhnhhlubaubhB)Åqt}qu(hXÏ���All 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]uh3Kh4hh5]qw(h>X(���All of these documents are formatted in qxÖÅqy}qz(hX(���All of these documents are formatted in hhtubhK)Åq{}q|(hX���reStructuredText_hNKhhth'hOh)}q}(UnameX���reStructuredTexthQX;���http://docutils.sourceforge.net/docs/user/rst/quickref.htmlq~h.]h-]h+]h,]h1]uh5]qh>X���reStructuredTextqÄÖÅqÅ}qÇ(hU�hh{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
qÉÖÅqÑ}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.htmlqàh)}qâ(Urefurihàh.]h-]h+]h,]h1]uhhth5]qäh>X%���http://sphinx.pocoo.org/contents.htmlqãÖÅqå}qç(hU�hhÜubah'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>X™���Portions of content, specifically all the individual function and exception
descriptions, are maintained in an Excel spreadsheet (best edited using
OpenOffice Calc). The qíÖÅ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 hhéubhK)Åqï}qñ(hX���reStructuredText_hNKhhéh'hOh)}qó(UnameX���reStructuredTexthQh~h.]h-]h+]h,]h1]uh5]qòh>X���reStructuredTextqôÖÅqö}qõ(hU�hhïubaubh>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.qúÖÅqù}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.hhéubeubhB)Åqü}q†(hXfi���All 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).q°hheh%h&h'hEh)}q¢(h+]h,]h-]h.]h1]uh3Kh4hh5]q£h>Xfi���All 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).q§ÖÅq•}q¶(hh°hhüubaubhB)Åqß}q®(hXÉ��reStructuredText_ 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¨(hX���reStructuredText_hNKhhßh'hOh)}q≠(UnameX���reStructuredTexthQh~h.]h-]h+]h,]h1]uh5]qÆh>X���reStructuredTextqØÖÅq∞}q±(hU�hh´ubaubh>XX��� can be edited with any plain text editor. These documents
have been edited mainly with q≤ÖÅq≥}q¥(hXX��� can be edited with any plain text editor. These documents
have been edited mainly with hhßubhK)Åqµ}q∂(hX	���TextMate_hNKhhßh'hOh)}q∑(UnameX���TextMatehQX���http://macromates.com/q∏h.]h-]h+]h,]h1]uh5]qπh>X���TextMateq∫ÖÅqª}qº(hU�hhµubaubh>X2��� on OS X, which offers a preview feature
when the qΩÖÅqæ}qø(hX2��� on OS X, which offers a preview feature
when the hhßubhK)Åq¿}q¡(hX���`reStructuredText bundle`_hNKhhßh'hOh)}q¬(UnameX���reStructuredText bundlehQX5���https://github.com/textmate/restructuredtext.tmbundleq√h.]h-]h+]h,]h1]uh5]qƒh>X���reStructuredText bundleq≈ÖÅq∆}q«(hU�hh¿ubaubh>X8��� is installed. Other editors that work well
for editing q»ÖÅq…}q (hX8��� is installed. Other editors that work well
for editing hhßubhK)ÅqÀ}qÃ(hX���reStructuredText_hNKhhßh'hOh)}qÕ(UnameX���reStructuredTexthQh~h.]h-]h+]h,]h1]uh5]qŒh>X���reStructuredTextqœÖÅq–}q—(hU�hhÀubaubh>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.hhßubeubhB)Åq’}q÷(hX±���Follow 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 hh’ubhK)Åq‹}q›(hX���`built out version`_hNKhh’h'hOh)}qfi(UnameX���built out versionhQX$���http://129.24.0.15/ArchitectureDocs/qflh.]h-]h+]h,]h1]uh5]q‡h>X���built out versionq·ÖÅq‚}q„(hU�hh‹ubaubh>X!��� of the docs
within five minutes.q‰ÖÅqÂ}qÊ(hX!��� of the docs
within five minutes.hh’ubeubhB)ÅqÁ}qË(hXK���The convention for different levels of heading used in these documents is::qÈhheh%h&h'hEh)}qÍ(h+]h,]h-]h.]h1]uh3K%h4hh5]qÎh>XJ���The convention for different levels of heading used in these documents is:qÏÖÅqÌ}qÓ(hXJ���The convention for different levels of heading used in these documents is:hhÁubaubcdocutils.nodes
literal_block
qÔ)Åq}qÒ(hX3���===  Level 1
---  Level 2
~~~  Level 3
...  Level 4hheh%h&h'U
literal_blockqÚh)}qÛ(U	xml:spaceqÙUpreserveqıh.]h-]h+]h,]h1]uh3K'h4hh5]qˆh>X3���===  Level 1
---  Level 2
~~~  Level 3
...  Level 4q˜ÖÅq¯}q˘(hU�hhubaubeubh!eubh%h&h'h(h)}q˙(h+]h,]h-]h.]q˚Ubuilding-the-documentationq¸ah1]q˝hauh3K.h4hh5]q˛(h7)Åqˇ}r���(hX���Building the Documentationr��hh!h%h&h'h;h)}r��(h+]h,]h-]h.]h1]uh3K.h4hh5]r��h>X���Building the Documentationr��ÖÅr��}r��(hj��hhˇubaubhB)År��}r��(hX§��Sphinx_ 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��(hX���Sphinx_hNKhj��h'hOh)}r
��(UnameX���SphinxhQhRh.]h-]h+]h,]h1]uh5]r��h>X���Sphinxr��ÖÅr��}r��(hU�hj��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 r��ÖÅr��}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 hj��ubcdocutils.nodes
literal
r��)År��}r��(hX!���``tools/docutils/rst_directives``h)}r��(h+]h,]h-]h.]h1]uhj��h5]r��h>X���tools/docutils/rst_directivesr��ÖÅr��}r��(hU�hj��ubah'Uliteralr��ubh>X���). Portions of Sphinx and the r��ÖÅr��}r ��(hX���). Portions of Sphinx and the hj��ubhK)År!��}r"��(hX	���PlantUML_hNKhj��h'hOh)}r#��(UnameX���PlantUMLhQh]h.]h-]h+]h,]h1]uh5]r$��h>X���PlantUMLr%��ÖÅr&��}r'��(hU�hj!��ubaubh>X ���
extension have a dependency of r(��ÖÅr)��}r*��(hX ���
extension have a dependency of hj��ubhK)År+��}r,��(hX	���Graphviz_hNKhj��h'hOh)}r-��(UnameX���GraphvizhQX���http://www.graphviz.org/r.��h.]h-]h+]h,]h1]uh5]r/��h>X���Graphvizr0��ÖÅr1��}r2��(hU�hj+��ubaubh>XJ���, and this will need to be installed
in order to build the documents. The r3��ÖÅr4��}r5��(hXJ���, and this will need to be installed
in order to build the documents. The hj��ubhK)År6��}r7��(hX���rst2pdf_hNKhj��h'hOh)}r8��(UnameX���rst2pdfr9��hQX!���http://code.google.com/p/rst2pdf/r:��h.]h-]h+]h,]h1]uh5]r;��h>X���rst2pdfr<��ÖÅr=��}r>��(hU�hj6��ubaubh>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.hj��ubeubheubh%h&h'h(h)}rB��(h+]h,]h-]h.]rC��Usetting-up-a-build-environmentrD��ah1]rE��hauh3K7h4hh5]rF��(h7)ÅrG��}rH��(hX���Setting up a Build EnvironmentrI��hhh%h&h'h;h)}rJ��(h+]h,]h-]h.]h1]uh3K7h4hh5]rK��h>X���Setting up a Build EnvironmentrL��ÖÅrM��}rN��(hjI��hjG��ubaubhB)ÅrO��}rP��(hXfi���The 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.rQ��hhh%h&h'hEh)}rR��(h+]h,]h-]h.]h1]uh3K9h4hh5]rS��h>Xfi���The 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.rT��ÖÅrU��}rV��(hjQ��hjO��ubaubcdocutils.nodes
enumerated_list
rW��)ÅrX��}rY��(hU�hhh%h&h'Uenumerated_listrZ��h)}r[��(Usuffixr\��U.h.]h-]h+]Uprefixr]��U�h,]h1]Uenumtyper^��Uarabicr_��uh3K=h4hh5]r`��(cdocutils.nodes
list_item
ra��)Årb��}rc��(hX6���Install graphviz::

  $ sudo apt-get install graphviz
hjX��h%h&h'U	list_itemrd��h)}re��(h+]h,]h-]h.]h1]uh3Nh4hh5]rf��(hB)Årg��}rh��(hX���Install graphviz::hjb��h%h&h'hEh)}ri��(h+]h,]h-]h.]h1]uh3K=h5]rj��h>X���Install graphviz:rk��ÖÅrl��}rm��(hX���Install graphviz:hjg��ubaubhÔ)Årn��}ro��(hX���$ sudo apt-get install graphvizhjb��h'hÚh)}rp��(hÙhıh.]h-]h+]h,]h1]uh3K?h5]rq��h>X���$ sudo apt-get install graphvizrr��ÖÅrs��}rt��(hU�hjn��ubaubeubja��)Åru��}rv��(hXC���Install Sphinx (latest version)::

  $ sudo easy_install -U Sphinx
hjX��h%h&h'jd��h)}rw��(h+]h,]h-]h.]h1]uh3Nh4hh5]rx��(hB)Åry��}rz��(hX!���Install Sphinx (latest version)::hju��h%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):hjy��ubaubhÔ)ÅrÄ��}rÅ��(hX���$ sudo easy_install -U Sphinxhju��h'hÚh)}rÇ��(hÙhıh.]h-]h+]h,]h1]uh3KCh5]rÉ��h>X���$ sudo easy_install -U SphinxrÑ��ÖÅrÖ��}rÜ��(hU�hjÄ��ubaubeubja��)Årá��}rà��(hX?���(Optional) Install rst2pdf::

  $ sudo easy_install -U rst2pdf
hjX��h%h&h'jd��h)}râ��(h+]h,]h-]h.]h1]uh3Nh4hh5]rä��(hB)Årã��}rå��(hX���(Optional) Install rst2pdf::hjá��h%h&h'hEh)}rç��(h+]h,]h-]h.]h1]uh3KEh5]ré��h>X���(Optional) Install rst2pdf:rè��ÖÅrê��}rë��(hX���(Optional) Install rst2pdf:hjã��ubaubhÔ)Årí��}rì��(hX���$ sudo easy_install -U rst2pdfhjá��h'hÚh)}rî��(hÙhıh.]h-]h+]h,]h1]uh3KGh5]rï��h>X���$ sudo easy_install -U rst2pdfrñ��ÖÅró��}rò��(hU�hjí��ubaubeubja��)Å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

hjX��h%h&h'jd��h)}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)::hjô��h%h&h'hEh)}rü��(h+]h,]h-]h.]h1]uh3KIh5]r†��(h>XF���(Optional) Edits to the method descriptions in the excel spreadsheet
(r°��ÖÅr¢��}r£��(hXF���(Optional) Edits to the method descriptions in the excel spreadsheet
(hjù��ubj��)År§��}r•��(hX���``MethodCrossReference.xls``h)}r¶��(h+]h,]h-]h.]h1]uhjù��h5]rß��h>X���MethodCrossReference.xlsr®��ÖÅr©��}r™��(hU�hj§��ubah'j��ubh>Xz���) require regeneration of some portions of the
documentation, which requires a couple of Python libraries (xlrd and xlwt):r´��ÖÅr¨��}r≠��(hXz���) require regeneration of some portions of the
documentation, which requires a couple of Python libraries (xlrd and xlwt):hjù��ubeubhÔ)ÅrÆ��}rØ��(hX���$ sudo easy_install xlrd xlwthjô��h'hÚh)}r∞��(hÙhıh.]h-]h+]h,]h1]uh3KMh5]r±��h>X���$ sudo easy_install xlrd xlwtr≤��ÖÅr≥��}r¥��(hU�hjÆ��ubaubeubja��)Årµ��}r∂��(hXú���Checkout a copy of the documentation from subversion::

  $ svn co https://repository.dataone.org/documents/Projects/cicore/architecture/api-documentation

hjX��h%h&h'jd��h)}r∑��(h+]h,]h-]h.]h1]uh3Nh4hh5]r∏��(hB)Årπ��}r∫��(hX6���Checkout a copy of the documentation from subversion::hjµ��h%h&h'hEh)}rª��(h+]h,]h-]h.]h1]uh3KPh5]rº��h>X5���Checkout a copy of the documentation from subversion:rΩ��ÖÅræ��}rø��(hX5���Checkout a copy of the documentation from subversion:hjπ��ubaubhÔ)År¿��}r¡��(hX`���$ svn co https://repository.dataone.org/documents/Projects/cicore/architecture/api-documentationhjµ��h'hÚh)}r¬��(hÙhıh.]h-]h+]h,]h1]uh3KRh5]r√��h>X`���$ svn co https://repository.dataone.org/documents/Projects/cicore/architecture/api-documentationrƒ��ÖÅr≈��}r∆��(hU�hj¿��ubaubeubja��)År«��}r»��(hXü���Build the documents::

  $ cd api-documentation
  $ make html

The documents will be available in ``build/html``, with ``index.html`` being the root document.
hjX��h%h&h'jd��h)}r…��(h+]h,]h-]h.]h1]uh3Nh4hh5]r ��(hB)ÅrÀ��}rÃ��(hX���Build the documents::hj«��h%h&h'hEh)}rÕ��(h+]h,]h-]h.]h1]uh3KUh5]rŒ��h>X���Build the documents:rœ��ÖÅr–��}r—��(hX���Build the documents:hjÀ��ubaubhÔ)År“��}r”��(hX"���$ cd api-documentation
$ make htmlhj«��h'hÚh)}r‘��(hÙhıh.]h-]h+]h,]h1]uh3KWh5]r’��h>X"���$ cd api-documentation
$ make htmlr÷��ÖÅr◊��}rÿ��(hU�hj“��ubaubhB)ÅrŸ��}r⁄��(hX_���The documents will be available in ``build/html``, with ``index.html`` being the root document.hj«��h%h&h'hEh)}r€��(h+]h,]h-]h.]h1]uh3KZh5]r‹��(h>X#���The documents will be available in r›��ÖÅrfi��}rfl��(hX#���The documents will be available in hjŸ��ubj��)År‡��}r·��(hX���``build/html``h)}r‚��(h+]h,]h-]h.]h1]uhjŸ��h5]r„��h>X
���build/htmlr‰��ÖÅrÂ��}rÊ��(hU�hj‡��ubah'j��ubh>X���, with rÁ��ÖÅrË��}rÈ��(hX���, with hjŸ��ubj��)ÅrÍ��}rÎ��(hX���``index.html``h)}rÏ��(h+]h,]h-]h.]h1]uhjŸ��h5]rÌ��h>X
���index.htmlrÓ��ÖÅrÔ��}r��(hU�hjÍ��ubah'j��ubh>X��� being the root document.rÒ��ÖÅrÚ��}rÛ��(hX��� being the root document.hjŸ��ubeubeubeubcdocutils.nodes
bullet_list
rÙ��)Årı��}rˆ��(hU�hhh%h&h'Ubullet_listr˜��h)}r¯��(Ubulletr˘��X���*h.]h-]h+]h,]h1]uh3K\h4hh5]r˙��(ja��)År˚��}r¸��(hX£���If changes are made to ``MethodCrossReference.xls``, then an additional make
step is required::

     $ cd api-documentation
     $ make generate
     $ make html
hjı��h%h&h'jd��h)}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::hj˚��h%h&h'hEh)}r��(h+]h,]h-]h.]h1]uh3K\h5]r��(h>X���If changes are made to r��ÖÅr��}r��(hX���If changes are made to hjˇ��ubj��)År��}r��(hX���``MethodCrossReference.xls``h)}r��(h+]h,]h-]h.]h1]uhjˇ��h5]r	��h>X���MethodCrossReference.xlsr
��ÖÅr��}r��(hU�hj��ubah'j��ubh>X+���, then an additional make
step is required:r
��ÖÅr��}r��(hX+���, then an additional make
step is required:hjˇ��ubeubhÔ)År��}r��(hX2���$ cd api-documentation
$ make generate
$ make htmlhj˚��h'hÚh)}r��(hÙhıh.]h-]h+]h,]h1]uh3K_h5]r��h>X2���$ cd api-documentation
$ make generate
$ make htmlr��ÖÅr��}r��(hU�hj��ubaubeubja��)År��}r��(hXÂ��If 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.
hjı��h%h&h'jd��h)}r��(h+]h,]h-]h.]h1]uh3Nh4hh5]r��(hB)År��}r��(hXí���If changes to plantuml diagrams have been made then it will be necessary to
regenerate the associated .png images. This can be done using *make*::hj��h%h&h'hEh)}r��(h+]h,]h-]h.]h1]uh3Kch5]r��(h>X��If changes to plantuml diagrams have been made then it will be necessary to
regenerate the associated .png images. This can be done using r��ÖÅr ��}r!��(hXä���If changes to plantuml diagrams have been made then it will be necessary to
regenerate the associated .png images. This can be done using hj��ubcdocutils.nodes
emphasis
r"��)År#��}r$��(hX���*make*h)}r%��(h+]h,]h-]h.]h1]uhj��h5]r&��h>X���maker'��ÖÅr(��}r)��(hU�hj#��ubah'Uemphasisr*��ubh>X���:ÖÅr+��}r,��(hX���:hj��ubeubhÔ)År-��}r.��(hX2���$ cd api-documentation
$ make plantuml
$ make htmlhj��h'hÚh)}r/��(hÙhıh.]h-]h+]h,]h1]uh3Kfh5]r0��h>X2���$ cd api-documentation
$ make plantuml
$ make htmlr1��ÖÅr2��}r3��(hU�hj-��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.hj��h%h&h'hEh)}r6��(h+]h,]h-]h.]h1]uh3Kjh5]r7��(h>XP���The plantuml diagram generation can take a while. There are three sub-tasks
for r8��ÖÅr9��}r:��(hXP���The plantuml diagram generation can take a while. There are three sub-tasks
for hj4��ubj"��)År;��}r<��(hX���*make*h)}r=��(h+]h,]h-]h.]h1]uhj4��h5]r>��h>X���maker?��ÖÅr@��}rA��(hU�hj;��ubah'j*��ubh>Xf���, plantuml_source, plantuml_usecase, and plantuml_types which can
be used to build diagrams under the rB��ÖÅrC��}rD��(hXf���, plantuml_source, plantuml_usecase, and plantuml_types which can
be used to build diagrams under the hj4��ubj"��)ÅrE��}rF��(hX���*source/design*h)}rG��(h+]h,]h-]h.]h1]uhj4��h5]rH��h>X
���source/designrI��ÖÅrJ��}rK��(hU�hjE��ubah'j*��ubh>X���,
rL��ÖÅrM��}rN��(hX���,
hj4��ubj"��)ÅrO��}rP��(hX���*source/design/UseCases*h)}rQ��(h+]h,]h-]h.]h1]uhj4��h5]rR��h>X���source/design/UseCasesrS��ÖÅrT��}rU��(hU�hjO��ubah'j*��ubh>X���, or rV��ÖÅrW��}rX��(hX���, or hj4��ubj"��)ÅrY��}rZ��(hX
���*source/apis*h)}r[��(h+]h,]h-]h.]h1]uhj4��h5]r\��h>X���source/apisr]��ÖÅr^��}r_��(hU�hjY��ubah'j*��ubh>X��� folders respectively.r`��ÖÅra��}rb��(hX��� folders respectively.hj4��ubeubeubeubjW��)Årc��}rd��(hU�hhh%h&h'jZ��h)}re��(j\��U.Ustartrf��Kh.]h-]h+]j]��U�h,]h1]j^��j_��uh3Koh4hh5]rg��(ja��)Årh��}ri��(hXí���To 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.
hjc��h%h&h'jd��h)}rj��(h+]h,]h-]h.]h1]uh3Nh4hh5]rk��(hB)Årl��}rm��(hX*���To build a PDF version of the documents.::hjh��h%h&h'hEh)}rn��(h+]h,]h-]h.]h1]uh3Koh5]ro��h>X)���To build a PDF version of the documents.:rp��ÖÅrq��}rr��(hX)���To build a PDF version of the documents.:hjl��ubaubhÔ)Års��}rt��(hX
���$ make pdfhjh��h'hÚh)}ru��(hÙhıh.]h-]h+]h,]h1]uh3Kqh5]rv��h>X
���$ make pdfrw��ÖÅrx��}ry��(hU�hjs��ubaubhB)Årz��}r{��(hXW���Note that the PDF generator can be quite fickle, and may require some tweaking to work.r|��hjh��h%h&h'hEh)}r}��(h+]h,]h-]h.]h1]uh3Ksh5]r~��h>XW���Note that the PDF generator can be quite fickle, and may require some tweaking to work.r��ÖÅrÄ��}rÅ��(hj|��hjz��ubaubeubja��)ÅrÇ��}rÉ��(hX=���To build an ePub version of the documents::

  $ make epub


hjc��h%h&h'jd��h)}rÑ��(h+]h,]h-]h.]h1]uh3Nh4hh5]rÖ��(hB)ÅrÜ��}rá��(hX+���To build an ePub version of the documents::rà��hjÇ��h%h&h'hEh)}râ��(h+]h,]h-]h.]h1]uh3Kuh5]rä��h>X*���To build an ePub version of the documents:rã��ÖÅrå��}rç��(hX*���To build an ePub version of the documents:hjÜ��ubaubhÔ)Åré��}rè��(hX���$ make epubhjÇ��h'hÚh)}rê��(hÙhıh.]h-]h+]h,]h1]uh3Kwh5]rë��h>X���$ make epubrí��ÖÅrì��}rî��(hU�hjé��ubaubeubeubcdocutils.nodes
target
rï��)Årñ��}ró��(hX&���.. _Graphviz: http://www.graphviz.org/U
referencedrò��Khhh%h&h'Utargetrô��h)}rö��(hQj.��h.]rõ��Ugraphvizrú��ah-]h+]h,]h1]rù��h
auh3K{h4hh5]ubjï��)Årû��}rü��(hX$���.. _Sphinx: http://sphinx.pocoo.org/jò��Khhh%h&h'jô��h)}r†��(hQhRh.]r°��Usphinxr¢��ah-]h+]h,]h1]r£��hauh3K}h4hh5]ubjï��)År§��}r•��(hX-���.. _PlantUML: http://plantuml.sourceforge.netjò��Khhh%h&h'jô��h)}r¶��(hQh]h.]rß��Uplantumlr®��ah-]h+]h,]h1]r©��hauh3Kh4hh5]ubjï��)År™��}r´��(hX*���.. _xlrd: http://pypi.python.org/pypi/xlrdhhh%h&h'jô��h)}r¨��(hQX ���http://pypi.python.org/pypi/xlrdh.]r≠��UxlrdrÆ��ah-]h+]h,]h1]rØ��hauh3KÅh4hh5]ubjï��)År∞��}r±��(hX6���.. _setuptools: http://pypi.python.org/pypi/setuptoolshhh%h&h'jô��h)}r≤��(hQX&���http://pypi.python.org/pypi/setuptoolsh.]r≥��U
setuptoolsr¥��ah-]h+]h,]h1]rµ��hauh3KÉh4hh5]ubjï��)År∂��}r∑��(hX.���.. _rst2pdf: http://code.google.com/p/rst2pdf/jò��Khhh%h&h'jô��h)}r∏��(hQj:��h.]rπ��Urst2pdfr∫��ah-]h+]h,]h1]rª��h
auh3KÖh4hh5]ubjï��)Årº��}rΩ��(hX;���.. _built out version: http://129.24.0.15/ArchitectureDocs/jò��Khhh%h&h'jô��h)}ræ��(hQhflh.]rø��Ubuilt-out-versionr¿��ah-]h+]h,]h1]r¡��hauh3Káh4hh5]ubjï��)År¬��}r√��(hX$���.. _TextMate: http://macromates.com/jò��Khhh%h&h'jô��h)}rƒ��(hQh∏h.]r≈��Utextmater∆��ah-]h+]h,]h1]r«��hauh3Kâh4hh5]ubjï��)År»��}r…��(hXR���.. _reStructuredText bundle: https://github.com/textmate/restructuredtext.tmbundlejò��Khhh%h&h'jô��h)}r ��(hQh√h.]rÀ��Urestructuredtext-bundlerÃ��ah-]h+]h,]h1]rÕ��h	auh3Kãh4hh5]ubjï��)ÅrŒ��}rœ��(hX ���.. _jEdit: http://www.jedit.org/hhh%h&h'jô��h)}r–��(hQX���http://www.jedit.org/h.]r—��Ujeditr“��ah-]h+]h,]h1]r”��hauh3Kçh4hh5]ubjï��)År‘��}r’��(hXQ���.. _reStructuredText: http://docutils.sourceforge.net/docs/user/rst/quickref.htmljò��Khhh%h&h'jô��h)}r÷��(hQh~h.]r◊��Urestructuredtextrÿ��ah-]h+]h,]h1]rŸ��hauh3Kèh4hh5]ubeubh%h&h'Usystem_messager⁄��h)}r€��(h+]UlevelKh.]h-]Usourceh&h,]h1]UlineKUtypeUINFOr‹��uh3Koh4hh5]r›��hB)Årfi��}rfl��(hX:���Enumerated list start value not ordinal-1: "7" (ordinal 7)h)}r‡��(h+]h,]h-]h.]h1]uhhh5]r·��h>X:���Enumerated list start value not ordinal-1: "7" (ordinal 7)r‚��ÖÅr„��}r‰��(hU�hjfi��ubah'hEubaubaUcurrent_sourcerÂ��NU
decorationrÊ��NUautofootnote_startrÁ��KUnameidsrË��}rÈ��(hj®��hj¢��hh0h	jÃ��h
j∫��hjÿ��hhih
jú��hj¿��hj“��hj¥��hj∆��hjÆ��hjD��hh¸uh5]rÍ��h#ahU�UtransformerrÎ��NU
footnote_refsrÏ��}rÌ��UrefnamesrÓ��}rÔ��(X���plantuml]r��(hZj!��eX���sphinx]rÒ��(hLj��eX���restructuredtext bundle]rÚ��h¿aX���restructuredtext]rÛ��(h{hïh´hÀej9��]rÙ��j6��aX���graphviz]rı��j+��aX���built out version]rˆ��h‹aX���textmate]r˜��hµauUsymbol_footnotesr¯��]r˘��Uautofootnote_refsr˙��]r˚��Usymbol_footnote_refsr¸��]r˝��U	citationsr˛��]rˇ��h4hUcurrent_liner���NUtransform_messagesr��]r��(h)År��}r��(hU�h)}r��(h+]UlevelKh.]h-]Usourceh&h,]h1]UlineKÅUtypej‹��uh5]r��hB)År��}r��(hU�h)}r	��(h+]h,]h-]h.]h1]uhj��h5]r
��h>X*���Hyperlink target "xlrd" is not referenced.r��ÖÅr��}r
��(hU�hj��ubah'hEubah'j⁄��ubh)År��}r��(hU�h)}r��(h+]UlevelKh.]h-]Usourceh&h,]h1]UlineKÉUtypej‹��uh5]r��hB)År��}r��(hU�h)}r��(h+]h,]h-]h.]h1]uhj��h5]r��h>X0���Hyperlink target "setuptools" is not referenced.r��ÖÅr��}r��(hU�hj��ubah'hEubah'j⁄��ubh)År��}r��(hU�h)}r��(h+]UlevelKh.]h-]Usourceh&h,]h1]UlineKçUtypej‹��uh5]r��hB)År��}r��(hU�h)}r��(h+]h,]h-]h.]h1]uhj��h5]r ��h>X+���Hyperlink target "jedit" is not referenced.r!��ÖÅr"��}r#��(hU�hj��ubah'hEubah'j⁄��ubeUreporterr$��NUid_startr%��KU
autofootnotesr&��]r'��U
citation_refsr(��}r)��Uindirect_targetsr*��]r+��Usettingsr,��(cdocutils.frontend
Values
r-��or.��}r/��(Ufootnote_backlinksr0��KUrecord_dependenciesr1��NUrfc_base_urlr2��Uhttps://tools.ietf.org/html/r3��U	tracebackr4��àUpep_referencesr5��NUstrip_commentsr6��NU
toc_backlinksr7��Uentryr8��U
language_coder9��Uenr:��U	datestampr;��NUreport_levelr<��KU_destinationr=��NU
halt_levelr>��KU
strip_classesr?��Nh;NUerror_encoding_error_handlerr@��UbackslashreplacerA��UdebugrB��NUembed_stylesheetrC��âUoutput_encoding_error_handlerrD��UstrictrE��U
sectnum_xformrF��KUdump_transformsrG��NU
docinfo_xformrH��KUwarning_streamrI��NUpep_file_url_templaterJ��Upep-%04drK��Uexit_status_levelrL��KUconfigrM��NUstrict_visitorrN��NUcloak_email_addressesrO��àUtrim_footnote_reference_spacerP��âUenvrQ��NUdump_pseudo_xmlrR��NUexpose_internalsrS��NUsectsubtitle_xformrT��âUsource_linkrU��NUrfc_referencesrV��NUoutput_encodingrW��Uutf-8rX��U
source_urlrY��NUinput_encodingrZ��U	utf-8-sigr[��U_disable_configr\��NU	id_prefixr]��U�U	tab_widthr^��KUerror_encodingr_��UUTF-8r`��U_sourcera��h&Ugettext_compactrb��àU	generatorrc��NUdump_internalsrd��NUsmart_quotesre��âUpep_base_urlrf��U https://www.python.org/dev/peps/rg��Usyntax_highlightrh��Ulongri��Uinput_encoding_error_handlerrj��jE��Uauto_id_prefixrk��Uidrl��Udoctitle_xformrm��âUstrip_elements_with_classesrn��NU
_config_filesro��]Ufile_insertion_enabledrp��àUraw_enabledrq��KU
dump_settingsrr��NubUsymbol_footnote_startrs��K�Uidsrt��}ru��(h¸h!j®��j§��j¢��jû��jD��hjÿ��j‘��j∫��j∂��h0h#jÃ��j»��jú��jñ��j¿��jº��j“��jŒ��j¥��j∞��j∆��j¬��jÆ��j™��hiheuUsubstitution_namesrv��}rw��h'h4h)}rx��(h+]h.]h-]Usourceh&h,]h1]uU	footnotesry��]rz��Urefidsr{��}r|��ub.