Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
PetrDlouhy committed Oct 4, 2019
1 parent 06a6ac1 commit f9b6721
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 197 deletions.
1 change: 1 addition & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Django admin charts
:target: https://pypi.python.org/pypi/django-admin-charts/
:alt: License

.. inclusion-marker-do-not-remove
Create beautiful configurable charts from your models and display them on the ``django-admin`` index page or on ``django-admin-tools`` dashboard.
The charts are based on models and criterias defined through admin interface and some chart parameters are configurable in live view.
Expand Down
12 changes: 2 additions & 10 deletions docs/source/developer-doc/modules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,11 @@ Django-admin-tools-stats Modules
:class:`DashboardChart`
-----------------------

Dashboard module with user registration charts. Default values are best suited
for 2-column dashboard layouts.

def **get_registrations(self, interval, days, graph_key, select_box_value):**
Returns an array with new users count per interval.

def **prepare_template_data(self, data, graph_key, select_box_value):**
Prepares data for template (passed as module attributes)

Dashboard module with user registration charts.

.. _DashboardCharts:

:class:`DashboardCharts`
------------------------

Group module with 3 default dashboard charts
Right now only dummy module with deprecation warning. We don't use module Groups any more.
106 changes: 3 additions & 103 deletions docs/source/includes/introduction.txt
Original file line number Diff line number Diff line change
@@ -1,110 +1,10 @@
:Version: |version|
:Date: |today|
:Keywords: django, python, plot, graph, nvd3, d3, dashboard
:Author: Arezqui Belaid
:Author: Arezqui Belaid, Petr Dlouhý
:License: MIT

--

.. _django-admin-tools-stats-synopsis:


Django-admin-tools-stats is a Django admin module that allows you to easily create charts on your dashboard based on specific models and criterias.

It will query your models and provide reporting and statistics graphs, simple to read and display on your Dashboard.

Django-admin-tools-stats is an open source project written in Python and using the ``Django`` Framework.



.. _overview:

Overview
========

Django-admin-tools-stats is a Django application which powers dashboard modules with customer statistics and charts.

The goal of this project is to quickly interrogate your model data to provide reports and statistics graphs which are simple to read and can be used on a Dashboard.


.. image:: ./_static/admin_dashboard.png
:width: 1000


.. _installation:

Installation
------------

Install, upgrade and uninstall django-nvd3.py with these commands::

$ sudo pip install django-admin-tools-stats
$ sudo pip install --upgrade django-admin-tools-stats
$ sudo pip uninstall django-admin-tools-stats

Or if you don't have `pip`::

$ sudo easy_install django-admin-tools-stats


.. _usage:

Usage
-----

These tools have been created to improve the django-admin-tools : http://django-admin-tools.readthedocs.org

With Django-admin-tools you will be able to create and include charts on your dashboard and monitor your data, for instance you can easily monitor new users signing up each day, or new campaigns created per week.

Django-admin-tools also allow you to display a button 'Select' that will behave as a filter on the model data.


.. _contributing:

Contributing
============

Development of django-admin-tools-stats takes place on Github:

https://github.com/Star2Billing/django-admin-tools-stats

Bug tracker: https://github.com/Star2Billing/django-admin-tools-stats/issues


.. _source_download:

Source download
===============

The source code is currently available on github. Fork away!

https://github.com/Star2Billing/django-admin-tools-stats

Available also on PyPi : https://pypi.python.org/pypi/django-admin-tools-stats


.. _documentation:

Documentation
=============

Find the project documentation : http://django-admin-user-stats.readthedocs.org


.. _credits:

Credits
=======

Django-admin-tools-stats was inspired by django-admin-user-stats :
https://github.com/kmike/django-admin-user-stats


.. _license:

License
=======

Copyright (c) 2011-2014 Arezqui Belaid <areski@gmail.com>

Django-nvd3 is licensed under MIT, see `MIT-LICENSE.txt`.
.. include:: ../../README.rst
:start-after: inclusion-marker-do-not-remove
3 changes: 1 addition & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Django Admin Tools Stats Documentation!
==========================
=======================================

:Release: |version|
:Date: |today|
Expand All @@ -20,7 +20,6 @@ Contents:
:maxdepth: 2

introduction
installation-overview
developer-doc


Expand Down
82 changes: 0 additions & 82 deletions docs/source/installation-overview.rst

This file was deleted.

0 comments on commit f9b6721

Please sign in to comment.