| OLD | NEW |
| (Empty) |
| 1 .. _documentation: | |
| 2 | |
| 3 ======================= | |
| 4 About the Documentation | |
| 5 ======================= | |
| 6 | |
| 7 boto's documentation uses the Sphinx__ documentation system, which in turn is | |
| 8 based on docutils__. The basic idea is that lightly-formatted plain-text | |
| 9 documentation is transformed into HTML, PDF, and any other output format. | |
| 10 | |
| 11 __ http://sphinx.pocoo.org/ | |
| 12 __ http://docutils.sf.net/ | |
| 13 | |
| 14 To actually build the documentation locally, you'll currently need to install | |
| 15 Sphinx -- ``easy_install Sphinx`` should do the trick. | |
| 16 | |
| 17 Then, building the html is easy; just ``make html`` from the ``docs`` directory. | |
| 18 | |
| 19 To get started contributing, you'll want to read the `ReStructuredText | |
| 20 Primer`__. After that, you'll want to read about the `Sphinx-specific markup`__ | |
| 21 that's used to manage metadata, indexing, and cross-references. | |
| 22 | |
| 23 __ http://sphinx.pocoo.org/rest.html | |
| 24 __ http://sphinx.pocoo.org/markup/ | |
| 25 | |
| 26 The main thing to keep in mind as you write and edit docs is that the more | |
| 27 semantic markup you can add the better. So:: | |
| 28 | |
| 29 Import ``boto`` to your script... | |
| 30 | |
| 31 Isn't nearly as helpful as:: | |
| 32 | |
| 33 Add :mod:`boto` to your script... | |
| 34 | |
| 35 This is because Sphinx will generate a proper link for the latter, which greatly | |
| 36 helps readers. There's basically no limit to the amount of useful markup you can | |
| 37 add. | |
| 38 | |
| 39 | |
| 40 The fabfile | |
| 41 ----------- | |
| 42 | |
| 43 There is a Fabric__ file that can be used to build and deploy the documentation | |
| 44 to a webserver that you ssh access to. | |
| 45 | |
| 46 __ http://fabfile.org | |
| 47 | |
| 48 To build and deploy:: | |
| 49 | |
| 50 cd docs/ | |
| 51 fab deploy:remote_path='/var/www/folder/whatever' --hosts=user@host | |
| 52 | |
| 53 This will get the latest code from subversion, add the revision number to the | |
| 54 docs conf.py file, call ``make html`` to build the documentation, then it will | |
| 55 tarball it up and scp up to the host you specified and untarball it in the | |
| 56 folder you specified creating a symbolic link from the untarballed versioned | |
| 57 folder to ``{remote_path}/boto-docs``. | |
| 58 | |
| 59 | |
| OLD | NEW |