diff options
| author | Kenneth Reitz <me@kennethreitz.org> | 2016-02-07 06:01:56 -0500 |
|---|---|---|
| committer | Kenneth Reitz <me@kennethreitz.org> | 2016-02-07 06:01:56 -0500 |
| commit | 8bded88559552241d2a5e6d735f97eb4d69175fb (patch) | |
| tree | 2a59b855fca878e44d4c8333d8bd212ccdc9a2c8 /docs | |
| parent | f8f57a467e71d92bc6ac9e44d5073eeda4c6bf6e (diff) | |
| download | tablib-8bded88559552241d2a5e6d735f97eb4d69175fb.tar.gz | |
update development guide
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/development.rst | 34 |
1 files changed, 0 insertions, 34 deletions
diff --git a/docs/development.rst b/docs/development.rst index 1124e9f..3ab05d5 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -8,11 +8,6 @@ Tablib is under active development, and contributors are welcome. If you have a feature request, suggestion, or bug report, please open a new issue on GitHub_. To submit patches, please send a pull request on GitHub_. -If you'd like to contribute, there's plenty to do. Here's a short todo list. - - .. include:: ../TODO.rst - - .. _GitHub: http://github.com/kennethreitz/tablib/ @@ -66,8 +61,6 @@ Feature / Hotfix / Release branches follow a `Successful Git Branching Model`_ . The "next release" branch. Likely unstable. ``master`` Current production release (|version|) on PyPi. -``gh-pages`` - Current release of http://docs.python-tablib.org. Each release is tagged. @@ -87,9 +80,7 @@ Adding New Formats Tablib welcomes new format additions! Format suggestions include: -* Tab Separated Values * MySQL Dump -* HTML Table Coding by Convention @@ -207,34 +198,9 @@ Your ``docs/_build/html`` directory will then contain an HTML representation of 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 Jekyll_, which is configured to ignore files and folders that begin with "``_``" (*ie.* **_static**). - - - - - - - and `sphinx-to-github`_. :: - - Installing sphinx-to-github is simple. :: - - $ pip install sphinx-to-github - - Running it against the docs is even simpler. :: - - $ sphinx-to-github _build/html - - Move the resulting files to the **gh-pages** branch of your repository, and push it up to GitHub. - .. _`reStructured Text`: http://docutils.sourceforge.net/rst.html .. _Sphinx: http://sphinx.pocoo.org .. _`GitHub Pages`: http://pages.github.com -.. _Jekyll: http://github.com/mojombo/jekyll -.. _`sphinx-to-github`: http://github.com/michaeljones/sphinx-to-github ---------- |