diff --git a/docs/Makefile b/docs/Makefile index 5dd06fa..e2acf94 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -196,3 +196,5 @@ rst: auto: sphinx-autobuild . _build/html + +watch: rst html auto diff --git a/docs/documentation/basic_customizations.rst b/docs/documentation/basic_customizations.rst index 1c260e9..8bd6817 100644 --- a/docs/documentation/basic_customizations.rst +++ b/docs/documentation/basic_customizations.rst @@ -1,8 +1,3 @@ -=============== - Documentation -=============== - - Basic customizations ==================== diff --git a/docs/documentation/builtin_styles.rst b/docs/documentation/builtin_styles.rst index ad9fa98..6106bac 100644 --- a/docs/documentation/builtin_styles.rst +++ b/docs/documentation/builtin_styles.rst @@ -1,8 +1,3 @@ -=============== - Documentation -=============== - - Built-in Styles =============== diff --git a/docs/documentation/chart_types.rst b/docs/documentation/chart_types.rst index b2d7b63..9a2dd9c 100644 --- a/docs/documentation/chart_types.rst +++ b/docs/documentation/chart_types.rst @@ -1,8 +1,3 @@ -=============== - Documentation -=============== - - Chart types =========== diff --git a/docs/documentation/custom_styles.rst b/docs/documentation/custom_styles.rst index 8b26130..35cdfc2 100644 --- a/docs/documentation/custom_styles.rst +++ b/docs/documentation/custom_styles.rst @@ -1,8 +1,3 @@ -=============== - Documentation -=============== - - Custom Styles ============= diff --git a/docs/documentation/first_steps.rst b/docs/documentation/first_steps.rst index 6e39452..3d5043e 100644 --- a/docs/documentation/first_steps.rst +++ b/docs/documentation/first_steps.rst @@ -1,8 +1,3 @@ -=============== - Documentation -=============== - - First steps =========== diff --git a/docs/documentation/index.rst b/docs/documentation/index.rst index baa6d86..a561a80 100644 --- a/docs/documentation/index.rst +++ b/docs/documentation/index.rst @@ -1,17 +1,18 @@ -=============== - Documentation -=============== - - User documentation ================== -- `First steps `_ - learn how to very simply make beautiful charts. -- `Charts types `_ - see what pygal can do for you. -- `Styles `_ - change the style. -- `Basic customizations `_ - start to improve your charts. -- `Interpolations `_ - smooth your lines. -- `Sparklines `_ - create simple sparklines. -- `Metadata `_ - enrich your graph. -- `Other customizations `_ - customize all the things. -- `Embedding in a web page `_ - see several ways to use pygal on the intertubes. +.. toctree:: + :maxdepth: 2 + + first_steps + chart_types + styles + basic_customizations + interpolations + sparks + metadata + other_customizations + builtin_styles + parametric_styles + custom_styles + web diff --git a/docs/documentation/interpolations.rst b/docs/documentation/interpolations.rst index b3013b3..0d45e63 100644 --- a/docs/documentation/interpolations.rst +++ b/docs/documentation/interpolations.rst @@ -1,8 +1,3 @@ -=============== - Documentation -=============== - - Interpolations ============== diff --git a/docs/documentation/metadata.rst b/docs/documentation/metadata.rst index 4d69f5e..f44df5b 100644 --- a/docs/documentation/metadata.rst +++ b/docs/documentation/metadata.rst @@ -1,8 +1,3 @@ -=============== - Documentation -=============== - - Metadata ======== diff --git a/docs/documentation/other_customizations.rst b/docs/documentation/other_customizations.rst index 7244c9d..30ce8e9 100644 --- a/docs/documentation/other_customizations.rst +++ b/docs/documentation/other_customizations.rst @@ -1,8 +1,3 @@ -=============== - Documentation -=============== - - Other customizations ==================== diff --git a/docs/documentation/parametric_styles.rst b/docs/documentation/parametric_styles.rst index c0995e8..60e7816 100644 --- a/docs/documentation/parametric_styles.rst +++ b/docs/documentation/parametric_styles.rst @@ -1,8 +1,3 @@ -=============== - Documentation -=============== - - Parametric Styles ================= diff --git a/docs/documentation/sparks.rst b/docs/documentation/sparks.rst index 2664aa3..dbb8578 100644 --- a/docs/documentation/sparks.rst +++ b/docs/documentation/sparks.rst @@ -1,8 +1,3 @@ -=============== - Documentation -=============== - - Sparklines ========== diff --git a/docs/documentation/styles.rst b/docs/documentation/styles.rst index 3084fc3..93c9e6c 100644 --- a/docs/documentation/styles.rst +++ b/docs/documentation/styles.rst @@ -1,6 +1,5 @@ -=============== - Documentation -=============== +Styles +====== There are three ways to style the charts: diff --git a/docs/documentation/web.rst b/docs/documentation/web.rst index acc43b4..d31bf98 100644 --- a/docs/documentation/web.rst +++ b/docs/documentation/web.rst @@ -1,8 +1,3 @@ -=============== - Documentation -=============== - - Embedding in a web page ======================= diff --git a/docs/download.rst b/docs/download.rst index eb9c38d..9256891 100644 --- a/docs/download.rst +++ b/docs/download.rst @@ -28,4 +28,4 @@ Pygal has been packaged for: - `Fedora `_ by ralph - `Gentoo `_ by Ben de Groot -If you are interested in creating packages for Linux distributions, `contact us `_. +If you are interested in creating packages for Linux distributions, `contact us `_. diff --git a/docs/index.rst b/docs/index.rst index 3715b77..e88f338 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -37,32 +37,32 @@ pygal is a SVG charting library written in python. It features various graph types: -- `Bar charts `_ +- `Bar charts `_ -- `Line charts `_ +- `Line charts `_ -- `XY charts `_ +- `XY charts `_ -- `Pie charts `_ +- `Pie charts `_ -- `Radar charts `_ +- `Radar charts `_ -- `Box plot `_ +- `Box plot `_ -- `Dot charts `_ +- `Dot charts `_ -- `Pyramid charts `_ +- `Pyramid charts `_ -- `Funnel charts `_ +- `Funnel charts `_ -- `Gauge charts `_ +- `Gauge charts `_ -- `Worldmap charts `_ +- `Worldmap charts `_ -- `Country charts `_ +- `Country charts `_ -Python/Css styling with some pre-defined themes. See `styling `_. +Python/Css styling with some pre-defined themes. See `styling `_. And a lot of options to `customize the charts. `_ @@ -79,7 +79,7 @@ More information in the `download page `_ Get started =========== -Start `here `_ to make your first steps. +Start `here `_ to make your first steps. Technical Description @@ -112,26 +112,9 @@ Read more :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 diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..f4dee48 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1 @@ +pygal_sphinx_directives