From 8d8ff5df40cc5f5bccfbb6064f7467732f1ff871 Mon Sep 17 00:00:00 2001 From: Florian Mounier Date: Thu, 2 Jul 2015 16:43:20 +0200 Subject: [PATCH] Try organizing rest files --- docs/Makefile | 5 +++- docs/{ => api}/modules.rst | 0 docs/{ => api}/pygal.graph.rst | 0 docs/{ => api}/pygal.rst | 0 docs/{ => api}/pygal.test.rst | 0 .../basic_customizations.rst | 0 docs/{ => documentation}/builtin_styles.rst | 0 docs/{ => documentation}/chart_types.rst | 0 docs/{ => documentation}/custom_styles.rst | 0 docs/{ => documentation}/first_steps.rst | 0 .../index.rst} | 0 docs/{ => documentation}/interpolations.rst | 0 docs/{ => documentation}/metadata.rst | 0 .../other_customizations.rst | 0 .../{ => documentation}/parametric_styles.rst | 0 docs/{ => documentation}/sparks.rst | 0 docs/{ => documentation}/styles.rst | 0 docs/{ => documentation}/web.rst | 0 docs/index.rst | 27 +++++++++++++++++-- 19 files changed, 29 insertions(+), 3 deletions(-) rename docs/{ => api}/modules.rst (100%) rename docs/{ => api}/pygal.graph.rst (100%) rename docs/{ => api}/pygal.rst (100%) rename docs/{ => api}/pygal.test.rst (100%) rename docs/{ => documentation}/basic_customizations.rst (100%) rename docs/{ => documentation}/builtin_styles.rst (100%) rename docs/{ => documentation}/chart_types.rst (100%) rename docs/{ => documentation}/custom_styles.rst (100%) rename docs/{ => documentation}/first_steps.rst (100%) rename docs/{documentation.rst => documentation/index.rst} (100%) rename docs/{ => documentation}/interpolations.rst (100%) rename docs/{ => documentation}/metadata.rst (100%) rename docs/{ => documentation}/other_customizations.rst (100%) rename docs/{ => documentation}/parametric_styles.rst (100%) rename docs/{ => documentation}/sparks.rst (100%) rename docs/{ => documentation}/styles.rst (100%) rename docs/{ => documentation}/web.rst (100%) diff --git a/docs/Makefile b/docs/Makefile index 412252b..5dd06fa 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -192,4 +192,7 @@ pseudoxml: @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." rst: - sphinx-apidoc -f -o . ../pygal + sphinx-apidoc -f -o api ../pygal + +auto: + sphinx-autobuild . _build/html diff --git a/docs/modules.rst b/docs/api/modules.rst similarity index 100% rename from docs/modules.rst rename to docs/api/modules.rst diff --git a/docs/pygal.graph.rst b/docs/api/pygal.graph.rst similarity index 100% rename from docs/pygal.graph.rst rename to docs/api/pygal.graph.rst diff --git a/docs/pygal.rst b/docs/api/pygal.rst similarity index 100% rename from docs/pygal.rst rename to docs/api/pygal.rst diff --git a/docs/pygal.test.rst b/docs/api/pygal.test.rst similarity index 100% rename from docs/pygal.test.rst rename to docs/api/pygal.test.rst diff --git a/docs/basic_customizations.rst b/docs/documentation/basic_customizations.rst similarity index 100% rename from docs/basic_customizations.rst rename to docs/documentation/basic_customizations.rst diff --git a/docs/builtin_styles.rst b/docs/documentation/builtin_styles.rst similarity index 100% rename from docs/builtin_styles.rst rename to docs/documentation/builtin_styles.rst diff --git a/docs/chart_types.rst b/docs/documentation/chart_types.rst similarity index 100% rename from docs/chart_types.rst rename to docs/documentation/chart_types.rst diff --git a/docs/custom_styles.rst b/docs/documentation/custom_styles.rst similarity index 100% rename from docs/custom_styles.rst rename to docs/documentation/custom_styles.rst diff --git a/docs/first_steps.rst b/docs/documentation/first_steps.rst similarity index 100% rename from docs/first_steps.rst rename to docs/documentation/first_steps.rst diff --git a/docs/documentation.rst b/docs/documentation/index.rst similarity index 100% rename from docs/documentation.rst rename to docs/documentation/index.rst diff --git a/docs/interpolations.rst b/docs/documentation/interpolations.rst similarity index 100% rename from docs/interpolations.rst rename to docs/documentation/interpolations.rst diff --git a/docs/metadata.rst b/docs/documentation/metadata.rst similarity index 100% rename from docs/metadata.rst rename to docs/documentation/metadata.rst diff --git a/docs/other_customizations.rst b/docs/documentation/other_customizations.rst similarity index 100% rename from docs/other_customizations.rst rename to docs/documentation/other_customizations.rst diff --git a/docs/parametric_styles.rst b/docs/documentation/parametric_styles.rst similarity index 100% rename from docs/parametric_styles.rst rename to docs/documentation/parametric_styles.rst diff --git a/docs/sparks.rst b/docs/documentation/sparks.rst similarity index 100% rename from docs/sparks.rst rename to docs/documentation/sparks.rst diff --git a/docs/styles.rst b/docs/documentation/styles.rst similarity index 100% rename from docs/styles.rst rename to docs/documentation/styles.rst diff --git a/docs/web.rst b/docs/documentation/web.rst similarity index 100% rename from docs/web.rst rename to docs/documentation/web.rst diff --git a/docs/index.rst b/docs/index.rst index 2d12cf3..3715b77 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -100,15 +100,38 @@ Optional dependencies PNG output requires `CairoSVG `_, `tinycss `_ and `cssselect `_. Install those with ``pip install CairoSVG tinycss cssselect``. -Unit testing needs `py.test `_ or `nosetests `_. +Unit testing needs `py.test `_ or `nosetests `_. Visual testing is based on `flask `_. -Contents: + +Read more +========= .. toctree:: :maxdepth: 2 + documentation/index + documentation/first_steps + documentation/chart_types + documentation/styles + documentation/basic_customizations + documentation/interpolations + documentation/sparks + documentation/metadata + documentation/other_customizations + documentation/builtin_styles + documentation/parametric_styles + documentation/custom_styles + documentation/web + + download + support + + api/modules + api/pygal + api/pygal.graph + api/pygal.test Indices and tables