Skip to content

Commit

Permalink
Merge pull request #419 from jnns/master
Browse files Browse the repository at this point in the history
Improve documentation.
  • Loading branch information
bmihelac committed Mar 7, 2016
2 parents ec990d8 + 9ec89fb commit 0e5695d
Show file tree
Hide file tree
Showing 25 changed files with 453 additions and 344 deletions.
17 changes: 15 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,19 @@ django-import-export

.. image:: https://travis-ci.org/django-import-export/django-import-export.svg?branch=master
:target: https://travis-ci.org/django-import-export/django-import-export
:alt: Build status on Travis-CI

.. image:: https://img.shields.io/pypi/v/django-import-export.svg
:target: https://pypi.python.org/pypi/django-import-export
:alt: Current version on PyPi

.. image:: https://img.shields.io/pypi/dm/django-import-export.svg
:target: https://pypi.python.org/pypi/django-import-export
:target: https://pypi.python.org/pypi/django-import-export
:alt: Downloads per month on PyPi

.. image:: http://readthedocs.org/projects/django-import-export/badge/?version=latest
:target: http://django-import-export.rtfd.org
:alt: Docmentation

django-import-export is a Django application and library for importing
and exporting data with included admin integration.
Expand All @@ -25,7 +34,7 @@ Features:

* export data respecting admin filters

.. image:: https://raw.github.com/django-import-export/django-import-export/master/docs/_static/images/django-import-export-change.png
.. image:: docs/_static/images/django-import-export-change.png


* Documentation: https://django-import-export.readthedocs.org/en/latest/
Expand Down Expand Up @@ -56,6 +65,10 @@ If you'd like to contribute, simply fork `the repository`_, commit your
changes to the **develop** branch (or branch off of it), and send a pull
request. Make sure you add yourself to AUTHORS_.

As most projects, we try to follow PEP8_ as closely as possible. Please bear
in mind that most pull requests will be rejected without proper unit testing.

.. _`PEP8`: https://www.python.org/dev/peps/pep-0008/
.. _`tablib`: https://github.com/kennethreitz/tablib
.. _`the repository`: https://github.com/django-import-export/django-import-export/
.. _AUTHORS: https://github.com/django-import-export/django-import-export/blob/master/AUTHORS
Binary file modified docs/_static/images/django-import-export-action.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_static/images/django-import-export-change.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_static/images/django-import-export-import-confirm.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_static/images/django-import-export-import.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/api_admin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,7 @@
Admin
=====

For instructions on how to use the models and mixins in this module, please refer to :ref:`admin-integration`.

.. automodule:: import_export.admin
:members:
6 changes: 3 additions & 3 deletions docs/api_tmp_storages.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
============
Tmp storages
============
==================
Temporary storages
==================

.. currentmodule:: import_export.tmp_storages

Expand Down
3 changes: 3 additions & 0 deletions docs/api_widgets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ Widgets
.. autoclass:: import_export.widgets.TimeWidget
:members:

.. autoclass:: import_export.widgets.DateTimeWidget
:members:

.. autoclass:: import_export.widgets.ForeignKeyWidget
:members:

Expand Down
11 changes: 6 additions & 5 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Changelog for django-import-export
==================================
Changelog
=========

0.4.3 (unreleased)
------------------
Expand All @@ -12,6 +12,7 @@ Changelog for django-import-export

- Add support for django.db.models.TimeField (#381)


0.4.2 (2015-12-18)
------------------

Expand Down Expand Up @@ -89,7 +90,7 @@ Changelog for django-import-export

- added use of get_diff_headers method into import.html template (#158)

- Try to use OrderedDict instead of SortedDict, which is deprecated in
- Try to use OrderedDict instead of SortedDict, which is deprecated in
Django 1.7 (#157)

- fixed #105 unicode import
Expand All @@ -112,9 +113,9 @@ Changelog for django-import-export

- Fixed XLS import on python 3. Optimized loop

- Fixed properly skipping row marked as skipped when importing data from
- Fixed properly skipping row marked as skipped when importing data from
the admin interface.

- Allow Resource.export to accept iterables as well as querysets

- Improve error messages
Expand Down
3 changes: 2 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@

# General information about the project.
project = u'django-import-export'
copyright = u'2012, Bojan Mihelac'
copyright = u'2012–2016, Bojan Mihelac'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down Expand Up @@ -90,6 +90,7 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
html_theme = "sphinx_rtd_theme"

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand Down
16 changes: 0 additions & 16 deletions docs/configuration.rst

This file was deleted.

10 changes: 0 additions & 10 deletions docs/contributing.rst

This file was deleted.

9 changes: 0 additions & 9 deletions docs/example_app.rst

This file was deleted.

0 comments on commit 0e5695d

Please sign in to comment.