diff options
Diffstat (limited to 'docs/development.rst')
| -rw-r--r-- | docs/development.rst | 27 |
1 files changed, 11 insertions, 16 deletions
diff --git a/docs/development.rst b/docs/development.rst index 90bdb43..1124e9f 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -46,7 +46,7 @@ Source Control Tablib source is controlled with Git_, the lean, mean, distributed source control machine. -The repository is publicly accessable. +The repository is publicly accessible. ``git clone git://github.com/kennethreitz/tablib.git`` @@ -67,11 +67,11 @@ Feature / Hotfix / Release branches follow a `Successful Git Branching Model`_ . ``master`` Current production release (|version|) on PyPi. ``gh-pages`` - Current release of http://tablib.org. + Current release of http://docs.python-tablib.org. Each release is tagged. -When submitting patches, please place your feature/change in its own branch prior to opening a pull reqeust on GitHub_. +When submitting patches, please place your feature/change in its own branch prior to opening a pull request on GitHub_. .. _Git: http://git-scm.org @@ -132,7 +132,7 @@ Tablib features a micro-framework for adding format support. The easiest way to 2. - Add your new format module to the :class:`tablib.formats.avalable` tuple. + Add your new format module to the :class:`tablib.formats.available` tuple. 3. Add a mock property to the :class:`Dataset <tablib.Dataset>` class with verbose `reStructured Text`_ docstring. This alleviates IDE confusion, and allows for pretty auto-generated Sphinx_ documentation. @@ -174,20 +174,15 @@ This will generate a **nosetests.xml** file, which can then be analyzed. Continuous Integration ---------------------- -Every commit made to the **develop** branch is automatically tested and inspected upon receipt with `Jenkins CI`_. If you have access to the main repository and broke the build, you will receive an email accordingly. +Every commit made to the **develop** branch is automatically tested and inspected upon receipt with `Travis CI`_. If you have access to the main repository and broke the build, you will receive an email accordingly. Anyone may view the build status and history at any time. - http://ci.kennethreitz.com/ - - -If you are trustworthy and plan to contribute to tablib on a regular basis, please contact `Kenneth Reitz`_ to get an account on the Jenkins Server. - + https://travis-ci.org/kennethreitz/tablib Additional reports will also be included here in the future, including :pep:`8` checks and stress reports for extremely large datasets. -.. _`Jenkins CI`: http://jenkins-ci.org/ -.. _`Kenneth Reitz`: http://kennethreitz.com/contact-me/ +.. _`Jenkins CI`: https://travis-ci.org/ .. _docs: @@ -210,13 +205,13 @@ Then, to build an HTML version of the docs, simply run the following from the ** Your ``docs/_build/html`` directory will then contain an HTML representation of the documentation, ready for publication on most web servers. -You can also generate the documentation in **ebpub**, **latex**, **json**, *&c* similarly. +You can also generate the documentation in **epub**, **latex**, **json**, *&c* similarly. .. admonition:: GitHub Pages To push the documentation up to `GitHub Pages`_, you will first need to run `sphinx-to-github`_ against your ``docs/_build/html`` directory. - GitHub Pages are powered by an HTML generation system called Jeckyl_, which is configured to ignore files and folders that begin with "``_``" (*ie.* **_static**). + GitHub Pages are powered by an HTML generation system called Jekyll_, which is configured to ignore files and folders that begin with "``_``" (*ie.* **_static**). @@ -238,9 +233,9 @@ You can also generate the documentation in **ebpub**, **latex**, **json**, *&c* .. _`reStructured Text`: http://docutils.sourceforge.net/rst.html .. _Sphinx: http://sphinx.pocoo.org .. _`GitHub Pages`: http://pages.github.com -.. _Jeckyl: http://github.com/mojombo/jekyll +.. _Jekyll: http://github.com/mojombo/jekyll .. _`sphinx-to-github`: http://github.com/michaeljones/sphinx-to-github ---------- -Make sure to check out the :ref:`API Documentation <api>`.
\ No newline at end of file +Make sure to check out the :ref:`API Documentation <api>`. |