Write configuration doc

Kozea · Jul 8, 2015 · 61d269d · 61d269d
1 parent 65bdc4a
commit 61d269d
Show file tree

Hide file tree

Showing 105 changed files with 1,818 additions and 1,307 deletions.
diff --git a/demo/moulinrouge/__init__.py b/demo/moulinrouge/__init__.py
@@ -50,7 +50,7 @@ def create_app():
     def before_request():
         if request.args.get('etree'):
             etree.to_etree()
-        else:
+        elif request.args.get('lxml'):
             etree.to_lxml()
 
     def _random(data, order):

diff --git a/demo/moulinrouge/tests.py b/demo/moulinrouge/tests.py
@@ -163,6 +163,14 @@ def test_gauge():
         gauge.add('No', [99, -99])
         return gauge.render_response()
 
+    @app.route('/test/gauge/log')
+    def test_gauge_log():
+        gauge = Gauge(logarithmic=True)
+
+        gauge.add('Need l', [200.3, 500.12])
+        gauge.add('Need z', [10, 1000.5])
+        return gauge.render_response()
+
     @app.route('/test/pyramid')
     def test_pyramid():
         pyramid = Pyramid()
@@ -713,4 +721,10 @@ def test_datetimeline():
         line.x_label_rotation = 45
         return line.render_response()
 
+    @app.route('/test/order_min')
+    def test_order_min():
+        line = Line(order_min=-32)
+        line.add('_', [1, 32, 12, .4, .009])
+        return line.render_response()
+
     return list(sorted(filter(lambda x: x.startswith('test'), locals())))
diff --git a/docs/Makefile b/docs/Makefile
@@ -50,6 +50,7 @@ help:
 
 clean:
 	rm -rf $(BUILDDIR)/*
+	rm -rf api/*
 
 html:
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@@ -192,7 +193,7 @@ pseudoxml:
 	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
 
 rst:
-	sphinx-apidoc -f -o api ../pygal
+	sphinx-apidoc -f -e -M -H API -o api ../pygal
 
 auto:
 	sphinx-autobuild . _build/html

diff --git a/docs/api.rst b/docs/api.rst
diff --git a/docs/api/modules.rst b/docs/api/modules.rst
@@ -1,5 +1,5 @@
-pygal
-=====
+API
+===
 
 .. toctree::
    :maxdepth: 4

diff --git a/docs/api/pygal.adapters.rst b/docs/api/pygal.adapters.rst
@@ -0,0 +1,7 @@
+pygal.adapters module
+=====================
+
+.. automodule:: pygal.adapters
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/api/pygal.colors.rst b/docs/api/pygal.colors.rst
@@ -0,0 +1,7 @@
+pygal.colors module
+===================
+
+.. automodule:: pygal.colors
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/api/pygal.config.rst b/docs/api/pygal.config.rst
@@ -0,0 +1,7 @@
+pygal.config module
+===================
+
+.. automodule:: pygal.config
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/api/pygal.etree.rst b/docs/api/pygal.etree.rst
@@ -0,0 +1,7 @@
+pygal.etree module
+==================
+
+.. automodule:: pygal.etree
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/api/pygal.graph.bar.rst b/docs/api/pygal.graph.bar.rst
@@ -0,0 +1,7 @@
+pygal.graph.bar module
+======================
+
+.. automodule:: pygal.graph.bar
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/api/pygal.graph.base.rst b/docs/api/pygal.graph.base.rst
@@ -0,0 +1,7 @@
+pygal.graph.base module
+=======================
+
+.. automodule:: pygal.graph.base
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/api/pygal.graph.box.rst b/docs/api/pygal.graph.box.rst
@@ -0,0 +1,7 @@
+pygal.graph.box module
+======================
+
+.. automodule:: pygal.graph.box
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/api/pygal.graph.dot.rst b/docs/api/pygal.graph.dot.rst
@@ -0,0 +1,7 @@
+pygal.graph.dot module
+======================
+
+.. automodule:: pygal.graph.dot
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/api/pygal.graph.funnel.rst b/docs/api/pygal.graph.funnel.rst
@@ -0,0 +1,7 @@
+pygal.graph.funnel module
+=========================
+
+.. automodule:: pygal.graph.funnel
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/api/pygal.graph.gauge.rst b/docs/api/pygal.graph.gauge.rst
@@ -0,0 +1,7 @@
+pygal.graph.gauge module
+========================
+
+.. automodule:: pygal.graph.gauge
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/api/pygal.graph.graph.rst b/docs/api/pygal.graph.graph.rst
@@ -0,0 +1,7 @@
+pygal.graph.graph module
+========================
+
+.. automodule:: pygal.graph.graph
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/api/pygal.graph.histogram.rst b/docs/api/pygal.graph.histogram.rst
@@ -0,0 +1,7 @@
+pygal.graph.histogram module
+============================
+
+.. automodule:: pygal.graph.histogram
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/api/pygal.graph.horizontal.rst b/docs/api/pygal.graph.horizontal.rst
@@ -0,0 +1,7 @@
+pygal.graph.horizontal module
+=============================
+
+.. automodule:: pygal.graph.horizontal
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/api/pygal.graph.horizontalbar.rst b/docs/api/pygal.graph.horizontalbar.rst
@@ -0,0 +1,7 @@
+pygal.graph.horizontalbar module
+================================
+
+.. automodule:: pygal.graph.horizontalbar
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/api/pygal.graph.horizontalstackedbar.rst b/docs/api/pygal.graph.horizontalstackedbar.rst
@@ -0,0 +1,7 @@
+pygal.graph.horizontalstackedbar module
+=======================================
+
+.. automodule:: pygal.graph.horizontalstackedbar
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/api/pygal.graph.line.rst b/docs/api/pygal.graph.line.rst
@@ -0,0 +1,7 @@
+pygal.graph.line module
+=======================
+
+.. automodule:: pygal.graph.line
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/api/pygal.graph.map.rst b/docs/api/pygal.graph.map.rst
@@ -0,0 +1,7 @@
+pygal.graph.map module
+======================
+
+.. automodule:: pygal.graph.map
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/api/pygal.graph.pie.rst b/docs/api/pygal.graph.pie.rst
@@ -0,0 +1,7 @@
+pygal.graph.pie module
+======================
+
+.. automodule:: pygal.graph.pie
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/api/pygal.graph.public.rst b/docs/api/pygal.graph.public.rst
@@ -0,0 +1,7 @@
+pygal.graph.public module
+=========================
+
+.. automodule:: pygal.graph.public
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/api/pygal.graph.pyramid.rst b/docs/api/pygal.graph.pyramid.rst
@@ -0,0 +1,7 @@
+pygal.graph.pyramid module
+==========================
+
+.. automodule:: pygal.graph.pyramid
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/api/pygal.graph.radar.rst b/docs/api/pygal.graph.radar.rst
@@ -0,0 +1,7 @@
+pygal.graph.radar module
+========================
+
+.. automodule:: pygal.graph.radar
+    :members:
+    :undoc-members:
+    :show-inheritance: