summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorKenneth Reitz <me@kennethreitz.org>2016-02-07 07:00:55 -0500
committerKenneth Reitz <me@kennethreitz.org>2016-02-07 07:00:55 -0500
commit8debeb26aca7cc9ef427c70ee9d577eb169f9560 (patch)
tree58316fe5669e86cbea9a1044e4978ffd3b4cc308 /docs
parent66d9e50984e7c66fd36fd86f2b469c2dae3636ba (diff)
parenta774789252d41522d4ec8b0e2c212aff4a33904d (diff)
downloadtablib-8debeb26aca7cc9ef427c70ee9d577eb169f9560.tar.gz
Merge branch 'develop' into import_export
# Conflicts: # tablib/core.py # tablib/formats/_csv.py # tablib/formats/_xlsx.py
Diffstat (limited to 'docs')
-rw-r--r--docs/_themes/kr/layout.html2
-rw-r--r--docs/_themes/kr_small/layout.html4
-rw-r--r--docs/development.rst34
-rw-r--r--docs/index.rst8
-rw-r--r--docs/install.rst21
-rw-r--r--docs/intro.rst4
-rw-r--r--docs/tutorial.rst10
7 files changed, 21 insertions, 62 deletions
diff --git a/docs/_themes/kr/layout.html b/docs/_themes/kr/layout.html
index 1431b49..470f017 100644
--- a/docs/_themes/kr/layout.html
+++ b/docs/_themes/kr/layout.html
@@ -13,7 +13,7 @@
&copy; Copyright {{ copyright }}.
</div>
<a href="https://github.com/kennethreitz/tablib">
- <img style="position: absolute; top: 0; right: 0; border: 0;" src="http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" />
+ <img style="position: absolute; top: 0; right: 0; border: 0;" src="//s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" />
</a>
<script type="text/javascript" src="//www.hellobar.com/hellobar.js"></script>
diff --git a/docs/_themes/kr_small/layout.html b/docs/_themes/kr_small/layout.html
index aa1716a..cab20c7 100644
--- a/docs/_themes/kr_small/layout.html
+++ b/docs/_themes/kr_small/layout.html
@@ -14,8 +14,8 @@
{% block relbar1 %}{% endblock %}
{% block relbar2 %}
{% if theme_github_fork %}
- <a href="http://github.com/{{ theme_github_fork }}"><img style="position: fixed; top: 0; right: 0; border: 0;"
- src="http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" /></a>
+ <a href="https://github.com/{{ theme_github_fork }}"><img style="position: fixed; top: 0; right: 0; border: 0;"
+ src="//s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" /></a>
{% endif %}
{% endblock %}
{% block sidebar1 %}{% endblock %}
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
----------
diff --git a/docs/index.rst b/docs/index.rst
index 7bf1a41..20103b6 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -26,13 +26,13 @@ Tablib is an :ref:`MIT Licensed <mit>` format-agnostic tabular dataset library,
::
- >>> data = tablib.Dataset(*[('Kenneth', 'Reitz', 23), ('Bessie', 'Monke', 22)],
- headers=['First Name', 'Last Name', 'Age'])
+ >>> data = tablib.Dataset(headers=['First Name', 'Last Name', 'Age'])
+ >>> map(data.append, [('Kenneth', 'Reitz', 22), ('Bessie', 'Monke', 21)])
- >>> data.json
+ >>> print data.json
[{"Last Name": "Reitz", "First Name": "Kenneth", "Age": 22}, {"Last Name": "Monke", "First Name": "Bessie", "Age": 21}]
- >>> data.yaml
+ >>> print data.yaml
- {Age: 22, First Name: Kenneth, Last Name: Reitz}
- {Age: 21, First Name: Bessie, Last Name: Monke}
diff --git a/docs/install.rst b/docs/install.rst
index 9df8ee8..7b0b00b 100644
--- a/docs/install.rst
+++ b/docs/install.rst
@@ -14,27 +14,10 @@ Installing Tablib
Distribute & Pip
----------------
-Installing Tablib is simple with `pip <http://www.pip-installer.org/>`_::
+Of course, the recommended way to install Tablib is with `pip <http://www.pip-installer.org/>`_::
$ pip install tablib
-or, with `easy_install <http://pypi.python.org/pypi/setuptools>`_::
-
- $ easy_install tablib
-
-But, you really `shouldn't do that <http://www.pip-installer.org/en/latest/other-tools.html#pip-compared-to-easy-install>`_.
-
-
-
-Cheeseshop Mirror
------------------
-
-If the Cheeseshop is down, you can also install Requests from Kenneth Reitz's personal `Cheeseshop mirror <pip.kreitz.co/>`_::
-
- $ pip install -i http://pip.kreitz.co/simple tablib
-
-
-
-------------------
Download the Source
@@ -89,4 +72,4 @@ When a new version is available, upgrading is simple::
$ pip install tablib --upgrade
-Now, go get a :ref:`Quick Start <quickstart>`. \ No newline at end of file
+Now, go get a :ref:`Quick Start <quickstart>`.
diff --git a/docs/intro.rst b/docs/intro.rst
index c3413f3..78a6180 100644
--- a/docs/intro.rst
+++ b/docs/intro.rst
@@ -10,7 +10,7 @@ Advanced features include, segregation, dynamic columns, tags / filtering, and
seamless format import/export.
-Philosphy
+Philosophy
---------
Tablib was developed with a few :pep:`20` idioms in mind.
@@ -90,4 +90,4 @@ Support for other Pythons will be rolled out soon.
-Now, go :ref:`Install Tablib <install>`. \ No newline at end of file
+Now, go :ref:`Install Tablib <install>`.
diff --git a/docs/tutorial.rst b/docs/tutorial.rst
index bd2dbc0..551b191 100644
--- a/docs/tutorial.rst
+++ b/docs/tutorial.rst
@@ -39,6 +39,7 @@ You can now start filling this :class:`Dataset <tablib.Dataset>` object with dat
+
-----------
Adding Rows
-----------
@@ -98,6 +99,15 @@ It's that easy.
--------------
+Importing Data
+--------------
+Creating a :class:`tablib.Dataset` object by importing a pre-existing file is simple. ::
+
+ imported_data = tablib.import_set(open('data.csv').read())
+
+This detects what sort of data is being passed in, and uses an appropriate formatter to do the import. So you can import from a variety of different file types.
+
+--------------
Exporting Data
--------------