€cdocutils.nodes document q)q}q(U nametypesq}q(X the fabfileqNX documentationqˆXabout the documentationqNuUsubstitution_defsq }q Uparse_messagesq ]q Ucurrent_sourceq NU decorationqNUautofootnote_startqKUnameidsq}q(hU the-fabfileqhU documentationqhUabout-the-documentationquUchildrenq]q(cdocutils.nodes target q)q}q(U rawsourceqX.. _documentation:UparentqhUsourceqXC/Users/kyleknap/Documents/GitHub/boto/docs/source/documentation.rstqUtagnameqUtargetqU attributesq }q!(Uidsq"]Ubackrefsq#]Udupnamesq$]Uclassesq%]Unamesq&]Urefidq'huUlineq(KUdocumentq)hh]ubcdocutils.nodes section q*)q+}q,(hUhhhhUexpect_referenced_by_nameq-}q.hhshUsectionq/h }q0(h$]h%]h#]h"]q1(hheh&]q2(hheuh(Kh)hUexpect_referenced_by_idq3}q4hhsh]q5(cdocutils.nodes title q6)q7}q8(hXAbout the Documentationq9hh+hhhUtitleq:h }q;(h$]h%]h#]h"]h&]uh(Kh)hh]q…q?}q@(hh9hh7ubaubcdocutils.nodes paragraph qA)qB}qC(hXàboto's documentation uses the Sphinx__ documentation system, which in turn is based on docutils__. The basic idea is that lightly-formatted plain-text documentation is transformed into HTML, PDF, and any other output format.hh+hhhU paragraphqDh }qE(h$]h%]h#]h"]h&]uh(Kh)hh]qF(h=Xboto's documentation uses the qG…qH}qI(hXboto's documentation uses the hhBubcdocutils.nodes reference qJ)qK}qL(hXSphinx__UresolvedqMKhhBhU referenceqNh }qO(UnameXSphinxUrefuriqPXhttp://sphinx.pocoo.org/qQh"]h#]h$]h%]h&]U anonymousqRKuh]qSh=XSphinxqT…qU}qV(hUhhKubaubh=X1 documentation system, which in turn is based on qW…qX}qY(hX1 documentation system, which in turn is based on hhBubhJ)qZ}q[(hX docutils__hMKhhBhhNh }q\(UnameXdocutilshPXhttp://docutils.sf.net/q]h"]h#]h$]h%]h&]hRKuh]q^h=Xdocutilsq_…q`}qa(hUhhZubaubh=X. The basic idea is that lightly-formatted plain-text documentation is transformed into HTML, PDF, and any other output format.qb…qc}qd(hX. The basic idea is that lightly-formatted plain-text documentation is transformed into HTML, PDF, and any other output format.hhBubeubh)qe}qf(hX__ http://sphinx.pocoo.org/U referencedqgKhh+hhhhh }qh(hPhQh"]qiUid1qjah#]h$]h%]h&]hRKuh(K h)hh]ubh)qk}ql(hX__ http://docutils.sf.net/hgKhh+hhhhh }qm(hPh]h"]qnUid2qoah#]h$]h%]h&]hRKuh(K h)hh]ubhA)qp}qq(hX„To actually build the documentation locally, you'll currently need to install Sphinx -- ``easy_install Sphinx`` should do the trick.hh+hhhhDh }qr(h$]h%]h#]h"]h&]uh(Kh)hh]qs(h=XXTo actually build the documentation locally, you'll currently need to install Sphinx -- qt…qu}qv(hXXTo actually build the documentation locally, you'll currently need to install Sphinx -- hhpubcdocutils.nodes literal qw)qx}qy(hX``easy_install Sphinx``h }qz(h$]h%]h#]h"]h&]uhhph]q{h=Xeasy_install Sphinxq|…q}}q~(hUhhxubahUliteralqubh=X should do the trick.q€…q}q‚(hX should do the trick.hhpubeubhA)qƒ}q„(hXPThen, building the html is easy; just ``make html`` from the ``docs`` directory.q…hh+hhhhDh }q†(h$]h%]h#]h"]h&]uh(Kh)hh]q‡(h=X&Then, building the html is easy; just qˆ…q‰}qŠ(hX&Then, building the html is easy; just hhƒubhw)q‹}qŒ(hX ``make html``h }q(h$]h%]h#]h"]h&]uhhƒh]qŽh=X make htmlq…q}q‘(hUhh‹ubahhubh=X from the q’…q“}q”(hX from the hhƒubhw)q•}q–(hX``docs``h }q—(h$]h%]h#]h"]h&]uhhƒh]q˜h=Xdocsq™…qš}q›(hUhh•ubahhubh=X directory.qœ…q}qž(hX directory.hhƒubeubhA)qŸ}q (hXÖTo get started contributing, you'll want to read the `ReStructuredText Primer`__. After that, you'll want to read about the `Sphinx-specific markup`__ that's used to manage metadata, indexing, and cross-references.hh+hhhhDh }q¡(h$]h%]h#]h"]h&]uh(Kh)hh]q¢(h=X5To get started contributing, you'll want to read the q£…q¤}q¥(hX5To get started contributing, you'll want to read the hhŸubhJ)q¦}q§(hX`ReStructuredText Primer`__hMKhhŸhhNh }q¨(UnameXReStructuredText PrimerhPX!http://sphinx.pocoo.org/rest.htmlq©h"]h#]h$]h%]h&]hRKuh]qªh=XReStructuredText Primerq«…q¬}q­(hUhh¦ubaubh=X,. After that, you'll want to read about the q®…q¯}q°(hX,. After that, you'll want to read about the hhŸubhJ)q±}q²(hX`Sphinx-specific markup`__hMKhhŸhhNh }q³(UnameXSphinx-specific markuphPXhttp://sphinx.pocoo.org/markup/q´h"]h#]h$]h%]h&]hRKuh]qµh=XSphinx-specific markupq¶…q·}q¸(hUhh±ubaubh=X@ that's used to manage metadata, indexing, and cross-references.q¹…qº}q»(hX@ that's used to manage metadata, indexing, and cross-references.hhŸubeubh)q¼}q½(hX$__ http://sphinx.pocoo.org/rest.htmlhgKhh+hhhhh }q¾(hPh©h"]q¿Uid3qÀah#]h$]h%]h&]hRKuh(Kh)hh]ubh)qÁ}qÂ(hX"__ http://sphinx.pocoo.org/markup/hgKhh+hhhhh }qÃ(hPh´h"]qÄUid4qÅah#]h$]h%]h&]hRKuh(Kh)hh]ubhA)qÆ}qÇ(hXwThe main thing to keep in mind as you write and edit docs is that the more semantic markup you can add the better. So::hh+hhhhDh }qÈ(h$]h%]h#]h"]h&]uh(Kh)hh]qÉh=XvThe main thing to keep in mind as you write and edit docs is that the more semantic markup you can add the better. So:qÊ…qË}qÌ(hXvThe main thing to keep in mind as you write and edit docs is that the more semantic markup you can add the better. So:hhÆubaubcdocutils.nodes literal_block qÍ)qÎ}qÏ(hX!Import ``boto`` to your script...hh+hhhU literal_blockqÐh }qÑ(U xml:spaceqÒUpreserveqÓh"]h#]h$]h%]h&]uh(Kh)hh]qÔh=X!Import ``boto`` to your script...qÕ…qÖ}q×(hUhhÎubaubhA)qØ}qÙ(hXIsn't nearly as helpful as::qÚhh+hhhhDh }qÛ(h$]h%]h#]h"]h&]uh(Kh)hh]qÜh=XIsn't nearly as helpful as:qÝ…qÞ}qß(hXIsn't nearly as helpful as:hhØubaubhÍ)qà}qá(hX!Add :mod:`boto` to your script...hh+hhhhÐh }qâ(hÒhÓh"]h#]h$]h%]h&]uh(K!h)hh]qãh=X!Add :mod:`boto` to your script...qä…qå}qæ(hUhhàubaubhA)qç}qè(hX¦This is because Sphinx will generate a proper link for the latter, which greatly helps readers. There's basically no limit to the amount of useful markup you can add.qéhh+hhhhDh }qê(h$]h%]h#]h"]h&]uh(K#h)hh]qëh=X¦This is because Sphinx will generate a proper link for the latter, which greatly helps readers. There's basically no limit to the amount of useful markup you can add.qì…qí}qî(hhéhhçubaubh*)qï}qð(hUhh+hhhh/h }qñ(h$]h%]h#]h"]qòhah&]qóhauh(K)h)hh]qô(h6)qõ}qö(hX The fabfileq÷hhïhhhh:h }qø(h$]h%]h#]h"]h&]uh(K)h)hh]qùh=X The fabfileqú…qû}qü(hh÷hhõubaubhA)qý}qþ(hXvThere is a Fabric__ file that can be used to build and deploy the documentation to a webserver that you ssh access to.hhïhhhhDh }qÿ(h$]h%]h#]h"]h&]uh(K+h)hh]r(h=X There is a r…r}r(hX There is a hhýubhJ)r}r(hXFabric__hMKhhýhhNh }r(UnameXFabrichPXhttp://fabfile.orgrh"]h#]h$]h%]h&]hRKuh]rh=XFabricr …r }r (hUhjubaubh=Xc file that can be used to build and deploy the documentation to a webserver that you ssh access to.r …r }r(hXc file that can be used to build and deploy the documentation to a webserver that you ssh access to.hhýubeubh)r}r(hX__ http://fabfile.orghgKhhïhhhhh }r(hPjh"]rUid5rah#]h$]h%]h&]hRKuh(K.h)hh]ubhA)r}r(hXTo build and deploy::rhhïhhhhDh }r(h$]h%]h#]h"]h&]uh(K0h)hh]rh=XTo build and deploy:r…r}r(hXTo build and deploy:hjubaubhÍ)r}r(hXLcd docs/ fab deploy:remote_path='/var/www/folder/whatever' --hosts=user@hosthhïhhhhÐh }r(hÒhÓh"]h#]h$]h%]h&]uh(K2h)hh]rh=XLcd docs/ fab deploy:remote_path='/var/www/folder/whatever' --hosts=user@hostr …r!}r"(hUhjubaubhA)r#}r$(hX[This will get the latest code from subversion, add the revision number to the docs conf.py file, call ``make html`` to build the documentation, then it will tarball it up and scp up to the host you specified and untarball it in the folder you specified creating a symbolic link from the untarballed versioned folder to ``{remote_path}/boto-docs``.hhïhhhhDh }r%(h$]h%]h#]h"]h&]uh(K5h)hh]r&(h=XfThis will get the latest code from subversion, add the revision number to the docs conf.py file, call r'…r(}r)(hXfThis will get the latest code from subversion, add the revision number to the docs conf.py file, call hj#ubhw)r*}r+(hX ``make html``h }r,(h$]h%]h#]h"]h&]uhj#h]r-h=X make htmlr.…r/}r0(hUhj*ubahhubh=XÌ to build the documentation, then it will tarball it up and scp up to the host you specified and untarball it in the folder you specified creating a symbolic link from the untarballed versioned folder to r1…r2}r3(hXÌ to build the documentation, then it will tarball it up and scp up to the host you specified and untarball it in the folder you specified creating a symbolic link from the untarballed versioned folder to hj#ubhw)r4}r5(hX``{remote_path}/boto-docs``h }r6(h$]h%]h#]h"]h&]uhj#h]r7h=X{remote_path}/boto-docsr8…r9}r:(hUhj4ubahhubh=X.…r;}r<(hX.hj#ubeubeubeubehUU transformerr=NU footnote_refsr>}r?Urefnamesr@}rAUsymbol_footnotesrB]rCUautofootnote_refsrD]rEUsymbol_footnote_refsrF]rGU citationsrH]rIh)hU current_linerJNUtransform_messagesrK]rLcdocutils.nodes system_message rM)rN}rO(hUh }rP(h$]UlevelKh"]h#]Usourcehh%]h&]UlineKUtypeUINFOrQuh]rRhA)rS}rT(hUh }rU(h$]h%]h#]h"]h&]uhjNh]rVh=X3Hyperlink target "documentation" is not referenced.rW…rX}rY(hUhjSubahhDubahUsystem_messagerZubaUreporterr[NUid_startr\KU autofootnotesr]]r^U citation_refsr_}r`Uindirect_targetsra]rbUsettingsrc(cdocutils.frontend Values rdore}rf(Ufootnote_backlinksrgKUrecord_dependenciesrhNU rfc_base_urlriUhttp://tools.ietf.org/html/rjU tracebackrkˆUpep_referencesrlNUstrip_commentsrmNU toc_backlinksrnUentryroU language_coderpUenrqU datestamprrNU report_levelrsKU _destinationrtNU halt_levelruKU strip_classesrvNh:NUerror_encoding_error_handlerrwUbackslashreplacerxUdebugryNUembed_stylesheetrz‰Uoutput_encoding_error_handlerr{Ustrictr|U sectnum_xformr}KUdump_transformsr~NU docinfo_xformrKUwarning_streamr€NUpep_file_url_templaterUpep-%04dr‚Uexit_status_levelrƒKUconfigr„NUstrict_visitorr…NUcloak_email_addressesr†ˆUtrim_footnote_reference_spacer‡‰UenvrˆNUdump_pseudo_xmlr‰NUexpose_internalsrŠNUsectsubtitle_xformr‹‰U source_linkrŒNUrfc_referencesrNUoutput_encodingrŽUutf-8rU source_urlrNUinput_encodingr‘U utf-8-sigr’U_disable_configr“NU id_prefixr”UU tab_widthr•KUerror_encodingr–UUTF-8r—U_sourcer˜hUgettext_compactr™ˆU generatorršNUdump_internalsr›NU smart_quotesrœ‰U pep_base_urlrUhttp://www.python.org/dev/peps/ržUsyntax_highlightrŸUlongr Uinput_encoding_error_handlerr¡j|Uauto_id_prefixr¢Uidr£Udoctitle_xformr¤‰Ustrip_elements_with_classesr¥NU _config_filesr¦]Ufile_insertion_enabledr§ˆU raw_enabledr¨KU dump_settingsr©NubUsymbol_footnote_startrªKUidsr«}r¬(jjhÅhÁhh+hohkhÀh¼hjhehhïhh+uUsubstitution_namesr­}r®hh)h }r¯(h$]h"]h#]Usourcehh%]h&]uU footnotesr°]r±Urefidsr²}r³h]r´hasub.