Browse Source

Gen docs

pull/373/merge
Florian Mounier 7 years ago
parent
commit
d8337ddf9a
  1. 8
      Makefile
  2. 4
      docs/api/pygal.adapters.rst
  3. 4
      docs/api/pygal.colors.rst
  4. 4
      docs/api/pygal.config.rst
  5. 4
      docs/api/pygal.etree.rst
  6. 4
      docs/api/pygal.formatters.rst
  7. 4
      docs/api/pygal.graph.bar.rst
  8. 4
      docs/api/pygal.graph.base.rst
  9. 4
      docs/api/pygal.graph.box.rst
  10. 4
      docs/api/pygal.graph.dot.rst
  11. 4
      docs/api/pygal.graph.dual.rst
  12. 4
      docs/api/pygal.graph.funnel.rst
  13. 4
      docs/api/pygal.graph.gauge.rst
  14. 4
      docs/api/pygal.graph.graph.rst
  15. 4
      docs/api/pygal.graph.histogram.rst
  16. 4
      docs/api/pygal.graph.horizontal.rst
  17. 4
      docs/api/pygal.graph.horizontalbar.rst
  18. 4
      docs/api/pygal.graph.horizontalline.rst
  19. 4
      docs/api/pygal.graph.horizontalstackedbar.rst
  20. 4
      docs/api/pygal.graph.horizontalstackedline.rst
  21. 4
      docs/api/pygal.graph.line.rst
  22. 4
      docs/api/pygal.graph.map.rst
  23. 4
      docs/api/pygal.graph.pie.rst
  24. 4
      docs/api/pygal.graph.public.rst
  25. 4
      docs/api/pygal.graph.pyramid.rst
  26. 4
      docs/api/pygal.graph.radar.rst
  27. 4
      docs/api/pygal.graph.rst
  28. 4
      docs/api/pygal.graph.solidgauge.rst
  29. 4
      docs/api/pygal.graph.stackedbar.rst
  30. 4
      docs/api/pygal.graph.stackedline.rst
  31. 4
      docs/api/pygal.graph.time.rst
  32. 4
      docs/api/pygal.graph.treemap.rst
  33. 4
      docs/api/pygal.graph.xy.rst
  34. 4
      docs/api/pygal.interpolate.rst
  35. 4
      docs/api/pygal.maps.rst
  36. 4
      docs/api/pygal.serie.rst
  37. 4
      docs/api/pygal.state.rst
  38. 4
      docs/api/pygal.stats.rst
  39. 4
      docs/api/pygal.style.rst
  40. 4
      docs/api/pygal.svg.rst
  41. 4
      docs/api/pygal.table.rst
  42. 4
      docs/api/pygal.test.conftest.rst
  43. 5
      docs/api/pygal.test.rst
  44. 4
      docs/api/pygal.test.test_bar.rst
  45. 4
      docs/api/pygal.test.test_box.rst
  46. 4
      docs/api/pygal.test.test_colors.rst
  47. 4
      docs/api/pygal.test.test_config.rst
  48. 4
      docs/api/pygal.test.test_date.rst
  49. 4
      docs/api/pygal.test.test_formatters.rst
  50. 4
      docs/api/pygal.test.test_graph.rst
  51. 4
      docs/api/pygal.test.test_histogram.rst
  52. 4
      docs/api/pygal.test.test_interpolate.rst
  53. 4
      docs/api/pygal.test.test_line.rst
  54. 7
      docs/api/pygal.test.test_line_log_none_max_solved.rst
  55. 4
      docs/api/pygal.test.test_maps.rst
  56. 4
      docs/api/pygal.test.test_pie.rst
  57. 4
      docs/api/pygal.test.test_serie_config.rst
  58. 4
      docs/api/pygal.test.test_sparktext.rst
  59. 4
      docs/api/pygal.test.test_stacked.rst
  60. 4
      docs/api/pygal.test.test_style.rst
  61. 4
      docs/api/pygal.test.test_table.rst
  62. 4
      docs/api/pygal.test.test_util.rst
  63. 4
      docs/api/pygal.test.test_view.rst
  64. 4
      docs/api/pygal.test.test_xml_filters.rst
  65. 4
      docs/api/pygal.test.utils.rst
  66. 4
      docs/api/pygal.util.rst
  67. 4
      docs/api/pygal.view.rst
  68. 11
      docs/changelog.rst
  69. 1
      docs/documentation/custom_styles.rst
  70. 1
      setup.py

8
Makefile

@ -5,7 +5,7 @@ all: install lint check check-outdated
install: install:
test -d $(VENV) || virtualenv $(VENV) -p $(PYTHON_VERSION) test -d $(VENV) || virtualenv $(VENV) -p $(PYTHON_VERSION)
$(PIP) install --upgrade --no-cache --no-use-wheel pip setuptools -e .[test] devcore $(PIP) install --upgrade --no-cache --no-use-wheel pip setuptools -e .[test,docs] devcore
clean: clean:
rm -fr $(VENV) rm -fr $(VENV)
@ -21,6 +21,12 @@ check:
check-outdated: check-outdated:
$(PIP) list --outdated --format=columns $(PIP) list --outdated --format=columns
visual-check:
$(PYTHON) demo/moulinrouge.py
gen-docs:
cd docs && PYTHON_PATH=$(VENV) PATH=$(VENV)/bin:$(PATH) $(MAKE) rst html
release: release:
git pull git pull
$(eval VERSION := $(shell PROJECT_NAME=$(PROJECT_NAME) $(VENV)/bin/devcore bump $(LEVEL))) $(eval VERSION := $(shell PROJECT_NAME=$(PROJECT_NAME) $(VENV)/bin/devcore bump $(LEVEL)))

4
docs/api/pygal.adapters.rst

@ -1,5 +1,5 @@
pygal.adapters module pygal\.adapters module
===================== ======================
.. automodule:: pygal.adapters .. automodule:: pygal.adapters
:members: :members:

4
docs/api/pygal.colors.rst

@ -1,5 +1,5 @@
pygal.colors module pygal\.colors module
=================== ====================
.. automodule:: pygal.colors .. automodule:: pygal.colors
:members: :members:

4
docs/api/pygal.config.rst

@ -1,5 +1,5 @@
pygal.config module pygal\.config module
=================== ====================
.. automodule:: pygal.config .. automodule:: pygal.config
:members: :members:

4
docs/api/pygal.etree.rst

@ -1,5 +1,5 @@
pygal.etree module pygal\.etree module
================== ===================
.. automodule:: pygal.etree .. automodule:: pygal.etree
:members: :members:

4
docs/api/pygal.formatters.rst

@ -1,5 +1,5 @@
pygal.formatters module pygal\.formatters module
======================= ========================
.. automodule:: pygal.formatters .. automodule:: pygal.formatters
:members: :members:

4
docs/api/pygal.graph.bar.rst

@ -1,5 +1,5 @@
pygal.graph.bar module pygal\.graph\.bar module
====================== ========================
.. automodule:: pygal.graph.bar .. automodule:: pygal.graph.bar
:members: :members:

4
docs/api/pygal.graph.base.rst

@ -1,5 +1,5 @@
pygal.graph.base module pygal\.graph\.base module
======================= =========================
.. automodule:: pygal.graph.base .. automodule:: pygal.graph.base
:members: :members:

4
docs/api/pygal.graph.box.rst

@ -1,5 +1,5 @@
pygal.graph.box module pygal\.graph\.box module
====================== ========================
.. automodule:: pygal.graph.box .. automodule:: pygal.graph.box
:members: :members:

4
docs/api/pygal.graph.dot.rst

@ -1,5 +1,5 @@
pygal.graph.dot module pygal\.graph\.dot module
====================== ========================
.. automodule:: pygal.graph.dot .. automodule:: pygal.graph.dot
:members: :members:

4
docs/api/pygal.graph.dual.rst

@ -1,5 +1,5 @@
pygal.graph.dual module pygal\.graph\.dual module
======================= =========================
.. automodule:: pygal.graph.dual .. automodule:: pygal.graph.dual
:members: :members:

4
docs/api/pygal.graph.funnel.rst

@ -1,5 +1,5 @@
pygal.graph.funnel module pygal\.graph\.funnel module
========================= ===========================
.. automodule:: pygal.graph.funnel .. automodule:: pygal.graph.funnel
:members: :members:

4
docs/api/pygal.graph.gauge.rst

@ -1,5 +1,5 @@
pygal.graph.gauge module pygal\.graph\.gauge module
======================== ==========================
.. automodule:: pygal.graph.gauge .. automodule:: pygal.graph.gauge
:members: :members:

4
docs/api/pygal.graph.graph.rst

@ -1,5 +1,5 @@
pygal.graph.graph module pygal\.graph\.graph module
======================== ==========================
.. automodule:: pygal.graph.graph .. automodule:: pygal.graph.graph
:members: :members:

4
docs/api/pygal.graph.histogram.rst

@ -1,5 +1,5 @@
pygal.graph.histogram module pygal\.graph\.histogram module
============================ ==============================
.. automodule:: pygal.graph.histogram .. automodule:: pygal.graph.histogram
:members: :members:

4
docs/api/pygal.graph.horizontal.rst

@ -1,5 +1,5 @@
pygal.graph.horizontal module pygal\.graph\.horizontal module
============================= ===============================
.. automodule:: pygal.graph.horizontal .. automodule:: pygal.graph.horizontal
:members: :members:

4
docs/api/pygal.graph.horizontalbar.rst

@ -1,5 +1,5 @@
pygal.graph.horizontalbar module pygal\.graph\.horizontalbar module
================================ ==================================
.. automodule:: pygal.graph.horizontalbar .. automodule:: pygal.graph.horizontalbar
:members: :members:

4
docs/api/pygal.graph.horizontalline.rst

@ -1,5 +1,5 @@
pygal.graph.horizontalline module pygal\.graph\.horizontalline module
================================= ===================================
.. automodule:: pygal.graph.horizontalline .. automodule:: pygal.graph.horizontalline
:members: :members:

4
docs/api/pygal.graph.horizontalstackedbar.rst

@ -1,5 +1,5 @@
pygal.graph.horizontalstackedbar module pygal\.graph\.horizontalstackedbar module
======================================= =========================================
.. automodule:: pygal.graph.horizontalstackedbar .. automodule:: pygal.graph.horizontalstackedbar
:members: :members:

4
docs/api/pygal.graph.horizontalstackedline.rst

@ -1,5 +1,5 @@
pygal.graph.horizontalstackedline module pygal\.graph\.horizontalstackedline module
======================================== ==========================================
.. automodule:: pygal.graph.horizontalstackedline .. automodule:: pygal.graph.horizontalstackedline
:members: :members:

4
docs/api/pygal.graph.line.rst

@ -1,5 +1,5 @@
pygal.graph.line module pygal\.graph\.line module
======================= =========================
.. automodule:: pygal.graph.line .. automodule:: pygal.graph.line
:members: :members:

4
docs/api/pygal.graph.map.rst

@ -1,5 +1,5 @@
pygal.graph.map module pygal\.graph\.map module
====================== ========================
.. automodule:: pygal.graph.map .. automodule:: pygal.graph.map
:members: :members:

4
docs/api/pygal.graph.pie.rst

@ -1,5 +1,5 @@
pygal.graph.pie module pygal\.graph\.pie module
====================== ========================
.. automodule:: pygal.graph.pie .. automodule:: pygal.graph.pie
:members: :members:

4
docs/api/pygal.graph.public.rst

@ -1,5 +1,5 @@
pygal.graph.public module pygal\.graph\.public module
========================= ===========================
.. automodule:: pygal.graph.public .. automodule:: pygal.graph.public
:members: :members:

4
docs/api/pygal.graph.pyramid.rst

@ -1,5 +1,5 @@
pygal.graph.pyramid module pygal\.graph\.pyramid module
========================== ============================
.. automodule:: pygal.graph.pyramid .. automodule:: pygal.graph.pyramid
:members: :members:

4
docs/api/pygal.graph.radar.rst

@ -1,5 +1,5 @@
pygal.graph.radar module pygal\.graph\.radar module
======================== ==========================
.. automodule:: pygal.graph.radar .. automodule:: pygal.graph.radar
:members: :members:

4
docs/api/pygal.graph.rst

@ -1,5 +1,5 @@
pygal.graph package pygal\.graph package
=================== ====================
.. automodule:: pygal.graph .. automodule:: pygal.graph
:members: :members:

4
docs/api/pygal.graph.solidgauge.rst

@ -1,5 +1,5 @@
pygal.graph.solidgauge module pygal\.graph\.solidgauge module
============================= ===============================
.. automodule:: pygal.graph.solidgauge .. automodule:: pygal.graph.solidgauge
:members: :members:

4
docs/api/pygal.graph.stackedbar.rst

@ -1,5 +1,5 @@
pygal.graph.stackedbar module pygal\.graph\.stackedbar module
============================= ===============================
.. automodule:: pygal.graph.stackedbar .. automodule:: pygal.graph.stackedbar
:members: :members:

4
docs/api/pygal.graph.stackedline.rst

@ -1,5 +1,5 @@
pygal.graph.stackedline module pygal\.graph\.stackedline module
============================== ================================
.. automodule:: pygal.graph.stackedline .. automodule:: pygal.graph.stackedline
:members: :members:

4
docs/api/pygal.graph.time.rst

@ -1,5 +1,5 @@
pygal.graph.time module pygal\.graph\.time module
======================= =========================
.. automodule:: pygal.graph.time .. automodule:: pygal.graph.time
:members: :members:

4
docs/api/pygal.graph.treemap.rst

@ -1,5 +1,5 @@
pygal.graph.treemap module pygal\.graph\.treemap module
========================== ============================
.. automodule:: pygal.graph.treemap .. automodule:: pygal.graph.treemap
:members: :members:

4
docs/api/pygal.graph.xy.rst

@ -1,5 +1,5 @@
pygal.graph.xy module pygal\.graph\.xy module
===================== =======================
.. automodule:: pygal.graph.xy .. automodule:: pygal.graph.xy
:members: :members:

4
docs/api/pygal.interpolate.rst

@ -1,5 +1,5 @@
pygal.interpolate module pygal\.interpolate module
======================== =========================
.. automodule:: pygal.interpolate .. automodule:: pygal.interpolate
:members: :members:

4
docs/api/pygal.maps.rst

@ -1,5 +1,5 @@
pygal.maps package pygal\.maps package
================== ===================
.. automodule:: pygal.maps .. automodule:: pygal.maps
:members: :members:

4
docs/api/pygal.serie.rst

@ -1,5 +1,5 @@
pygal.serie module pygal\.serie module
================== ===================
.. automodule:: pygal.serie .. automodule:: pygal.serie
:members: :members:

4
docs/api/pygal.state.rst

@ -1,5 +1,5 @@
pygal.state module pygal\.state module
================== ===================
.. automodule:: pygal.state .. automodule:: pygal.state
:members: :members:

4
docs/api/pygal.stats.rst

@ -1,5 +1,5 @@
pygal.stats module pygal\.stats module
================== ===================
.. automodule:: pygal.stats .. automodule:: pygal.stats
:members: :members:

4
docs/api/pygal.style.rst

@ -1,5 +1,5 @@
pygal.style module pygal\.style module
================== ===================
.. automodule:: pygal.style .. automodule:: pygal.style
:members: :members:

4
docs/api/pygal.svg.rst

@ -1,5 +1,5 @@
pygal.svg module pygal\.svg module
================ =================
.. automodule:: pygal.svg .. automodule:: pygal.svg
:members: :members:

4
docs/api/pygal.table.rst

@ -1,5 +1,5 @@
pygal.table module pygal\.table module
================== ===================
.. automodule:: pygal.table .. automodule:: pygal.table
:members: :members:

4
docs/api/pygal.test.conftest.rst

@ -1,5 +1,5 @@
pygal.test.conftest module pygal\.test\.conftest module
========================== ============================
.. automodule:: pygal.test.conftest .. automodule:: pygal.test.conftest
:members: :members:

5
docs/api/pygal.test.rst

@ -1,5 +1,5 @@
pygal.test package pygal\.test package
================== ===================
.. automodule:: pygal.test .. automodule:: pygal.test
:members: :members:
@ -22,6 +22,7 @@ Submodules
pygal.test.test_histogram pygal.test.test_histogram
pygal.test.test_interpolate pygal.test.test_interpolate
pygal.test.test_line pygal.test.test_line
pygal.test.test_line_log_none_max_solved
pygal.test.test_maps pygal.test.test_maps
pygal.test.test_pie pygal.test.test_pie
pygal.test.test_serie_config pygal.test.test_serie_config

4
docs/api/pygal.test.test_bar.rst

@ -1,5 +1,5 @@
pygal.test.test_bar module pygal\.test\.test\_bar module
========================== =============================
.. automodule:: pygal.test.test_bar .. automodule:: pygal.test.test_bar
:members: :members:

4
docs/api/pygal.test.test_box.rst

@ -1,5 +1,5 @@
pygal.test.test_box module pygal\.test\.test\_box module
========================== =============================
.. automodule:: pygal.test.test_box .. automodule:: pygal.test.test_box
:members: :members:

4
docs/api/pygal.test.test_colors.rst

@ -1,5 +1,5 @@
pygal.test.test_colors module pygal\.test\.test\_colors module
============================= ================================
.. automodule:: pygal.test.test_colors .. automodule:: pygal.test.test_colors
:members: :members:

4
docs/api/pygal.test.test_config.rst

@ -1,5 +1,5 @@
pygal.test.test_config module pygal\.test\.test\_config module
============================= ================================
.. automodule:: pygal.test.test_config .. automodule:: pygal.test.test_config
:members: :members:

4
docs/api/pygal.test.test_date.rst

@ -1,5 +1,5 @@
pygal.test.test_date module pygal\.test\.test\_date module
=========================== ==============================
.. automodule:: pygal.test.test_date .. automodule:: pygal.test.test_date
:members: :members:

4
docs/api/pygal.test.test_formatters.rst

@ -1,5 +1,5 @@
pygal.test.test_formatters module pygal\.test\.test\_formatters module
================================= ====================================
.. automodule:: pygal.test.test_formatters .. automodule:: pygal.test.test_formatters
:members: :members:

4
docs/api/pygal.test.test_graph.rst

@ -1,5 +1,5 @@
pygal.test.test_graph module pygal\.test\.test\_graph module
============================ ===============================
.. automodule:: pygal.test.test_graph .. automodule:: pygal.test.test_graph
:members: :members:

4
docs/api/pygal.test.test_histogram.rst

@ -1,5 +1,5 @@
pygal.test.test_histogram module pygal\.test\.test\_histogram module
================================ ===================================
.. automodule:: pygal.test.test_histogram .. automodule:: pygal.test.test_histogram
:members: :members:

4
docs/api/pygal.test.test_interpolate.rst

@ -1,5 +1,5 @@
pygal.test.test_interpolate module pygal\.test\.test\_interpolate module
================================== =====================================
.. automodule:: pygal.test.test_interpolate .. automodule:: pygal.test.test_interpolate
:members: :members:

4
docs/api/pygal.test.test_line.rst

@ -1,5 +1,5 @@
pygal.test.test_line module pygal\.test\.test\_line module
=========================== ==============================
.. automodule:: pygal.test.test_line .. automodule:: pygal.test.test_line
:members: :members:

7
docs/api/pygal.test.test_line_log_none_max_solved.rst

@ -0,0 +1,7 @@
pygal\.test\.test\_line\_log\_none\_max\_solved module
======================================================
.. automodule:: pygal.test.test_line_log_none_max_solved
:members:
:undoc-members:
:show-inheritance:

4
docs/api/pygal.test.test_maps.rst

@ -1,5 +1,5 @@
pygal.test.test_maps module pygal\.test\.test\_maps module
=========================== ==============================
.. automodule:: pygal.test.test_maps .. automodule:: pygal.test.test_maps
:members: :members:

4
docs/api/pygal.test.test_pie.rst

@ -1,5 +1,5 @@
pygal.test.test_pie module pygal\.test\.test\_pie module
========================== =============================
.. automodule:: pygal.test.test_pie .. automodule:: pygal.test.test_pie
:members: :members:

4
docs/api/pygal.test.test_serie_config.rst

@ -1,5 +1,5 @@
pygal.test.test_serie_config module pygal\.test\.test\_serie\_config module
=================================== =======================================
.. automodule:: pygal.test.test_serie_config .. automodule:: pygal.test.test_serie_config
:members: :members:

4
docs/api/pygal.test.test_sparktext.rst

@ -1,5 +1,5 @@
pygal.test.test_sparktext module pygal\.test\.test\_sparktext module
================================ ===================================
.. automodule:: pygal.test.test_sparktext .. automodule:: pygal.test.test_sparktext
:members: :members:

4
docs/api/pygal.test.test_stacked.rst

@ -1,5 +1,5 @@
pygal.test.test_stacked module pygal\.test\.test\_stacked module
============================== =================================
.. automodule:: pygal.test.test_stacked .. automodule:: pygal.test.test_stacked
:members: :members:

4
docs/api/pygal.test.test_style.rst

@ -1,5 +1,5 @@
pygal.test.test_style module pygal\.test\.test\_style module
============================ ===============================
.. automodule:: pygal.test.test_style .. automodule:: pygal.test.test_style
:members: :members:

4
docs/api/pygal.test.test_table.rst

@ -1,5 +1,5 @@
pygal.test.test_table module pygal\.test\.test\_table module
============================ ===============================
.. automodule:: pygal.test.test_table .. automodule:: pygal.test.test_table
:members: :members:

4
docs/api/pygal.test.test_util.rst

@ -1,5 +1,5 @@
pygal.test.test_util module pygal\.test\.test\_util module
=========================== ==============================
.. automodule:: pygal.test.test_util .. automodule:: pygal.test.test_util
:members: :members:

4
docs/api/pygal.test.test_view.rst

@ -1,5 +1,5 @@
pygal.test.test_view module pygal\.test\.test\_view module
=========================== ==============================
.. automodule:: pygal.test.test_view .. automodule:: pygal.test.test_view
:members: :members:

4
docs/api/pygal.test.test_xml_filters.rst

@ -1,5 +1,5 @@
pygal.test.test_xml_filters module pygal\.test\.test\_xml\_filters module
================================== ======================================
.. automodule:: pygal.test.test_xml_filters .. automodule:: pygal.test.test_xml_filters
:members: :members:

4
docs/api/pygal.test.utils.rst

@ -1,5 +1,5 @@
pygal.test.utils module pygal\.test\.utils module
======================= =========================
.. automodule:: pygal.test.utils .. automodule:: pygal.test.utils
:members: :members:

4
docs/api/pygal.util.rst

@ -1,5 +1,5 @@
pygal.util module pygal\.util module
================= ==================
.. automodule:: pygal.util .. automodule:: pygal.util
:members: :members:

4
docs/api/pygal.view.rst

@ -1,5 +1,5 @@
pygal.view module pygal\.view module
================= ==================
.. automodule:: pygal.view .. automodule:: pygal.view
:members: :members:

11
docs/changelog.rst

@ -2,6 +2,17 @@
Changelog Changelog
========= =========
2.4.0
=====
* Generalized fix solidgauge squares algorithm (thanks @Necrote #385)
* Fix secondary series 'stroke_style' property (thanks @Yuliang-Lee #359)
* Fix wrong label colors when there are more series than colors (thanks @Brandhor #350)
* Show y guides in horizontal chart (thanks @yossisal #349)
* Fix nomenclature of Taiwan (thanks @pierrrrrrre #344)
* Better None values handling in logarithmic charts (thanks @ShuaiQin #343)
2.3.1 2.3.1
===== =====

1
docs/documentation/custom_styles.rst

@ -80,6 +80,7 @@ It is possible to give a google font to any font family property by specifying t
style = Style(font_family='googlefont:Raleway') style = Style(font_family='googlefont:Raleway')
NB: this won't work if you include the svg directly, you have to embed it because the google stylesheet is added in the XML processing instructions. (You could also manually add the google font in your HTML.)
Using a custom css Using a custom css
------------------ ------------------

1
setup.py

@ -80,6 +80,7 @@ setup(
package_data={'pygal': ['css/*', 'graph/maps/*.svg']}, package_data={'pygal': ['css/*', 'graph/maps/*.svg']},
extras_require={ extras_require={
'lxml': ['lxml'], 'lxml': ['lxml'],
'docs': ['sphinx', 'sphinx_rtd_theme', 'pygal_sphinx_directives'],
'png': [cairosvg], 'png': [cairosvg],
'test': tests_requirements 'test': tests_requirements
}, },

Loading…
Cancel
Save