Merge 250f3f2 into 6ddf049

Author: gillenbrown

docs/api_overview.rst

@@ -8,7 +8,6 @@ API Overview
 
 Top Level Functions
 --------------------
-
 The main function here is the :py:func:`subplots` function, but there is also a style
 function available (see the :ref:`styles` page).
 
@@ -50,7 +49,6 @@ These methods control various annotations, like the legend, tick marks, and axes
 
 .. autosummary::
     Axes_bpl.legend
-    Axes_bpl.data_ticks
     Axes_bpl.axhline
     Axes_bpl.axvline
     Axes_bpl.add_text
@@ -66,6 +64,7 @@ These methods control various annotations, like the legend, tick marks, and axes
     Axes_bpl.twin_axis_simple
     Axes_bpl.twin_axis
     Axes_bpl.make_ax_dark
+    Axes_bpl.data_ticks
 
 
 Non Object-Oriented Interface
@@ -75,6 +74,13 @@ In addition to the interface described above, all the Axes objects are accessibl
 without directly creating them. This works just like the `plt.whatever()` syntax in
 default matplotlib, just with `bpl.whatever()`.
 
-    
-
+Colors
+------
+The `bpl.color_cycle` attribute is a list of colors that I set as the default color
+cycle for plots. There are also a few other colors mentioned in the :ref:`styles`
+page. There are also few functions that can be used to handle colors and colormaps.
 
+.. autosummary::
+    create_mappable
+    fade_color
+    unfade_color

docs/full_api.rst

@@ -3,6 +3,12 @@
 Full API
 ============
 
+.. autofunction:: subplots
+.. autofunction:: set_style
+.. autofunction:: create_mappable
+.. autofunction:: fade_color
+.. autofunction:: unfade_color
+
 .. autoclass:: Axes_bpl
     :members:
     :exclude-members: set

docs/index.rst

@@ -28,14 +28,17 @@ The package is available in PyPI, so you can install with `pip install betterplo
 Documentation
 -------------
 
-The full documentation of the API is available through these pages:
+Full documentation of all the available functions, as well as example plots
+for each function, are available in the following pages. The Overview page has a
+summary list of all the available functions, while the examples and full documentation
+are in the Full API page.
 
 .. toctree::
    :maxdepth: 1
 
-   style
    api_overview
    full_api
+   style
 
 
 .. Indices and tables

docs/style.rst

@@ -12,9 +12,12 @@ are visible against a dark background in a presentation, and `bpl.set_style("lat
 uses LateX for font rendering.
 
 The general best practice is to call the style once at the beginning of the
-file or notebook, right after the imports. 
+file or notebook, right after the imports.
 
-.. autofunction:: set_style
+See the full documentation linked below for some examples.
+
+.. autosummary::
+    set_style
 
 
 Colors
@@ -30,8 +33,3 @@ make them slightly easier on the eyes. Here are all those defined colors.
 
 .. image:: images/colors.png
 
-There are also some functions to help out with managing colors and colorbars.
-
-.. autofunction:: create_mappable
-.. autofunction:: fade_color
-.. autofunction:: unfade_color

pyproject.toml

@@ -7,7 +7,7 @@ packages = ["betterplotlib"]
 
 [project]
 name = "betterplotlib"
-version = "1.12.3"
+version = "1.12.4"
 description = "Some wrappers for matplotlib to make plotting easier and nicer."
 readme = "README.md"
 license = {file = "LICENSE"}