[Docs] better formatting (not all on one page)

MinchinWeb · Jul 20, 2015 · ceeae95 · ceeae95
1 parent f181ebe
commit ceeae95
Show file tree

Hide file tree

Showing 9 changed files with 34 additions and 14 deletions.
diff --git a/colourettu/_palette.py b/colourettu/_palette.py
@@ -19,7 +19,7 @@ class palette:
     .. note::
 
         If a *string*, *tuple*, or *list* is provided for `start_colour` or
-        `end_colour`, a conversion to a *colourettu.colour* object will be
+        `end_colour`, a conversion to a :py:class:`colourettu.colour` object will be
         attempted.
 
     .. code:: python

diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -1,9 +1,11 @@
 Changelog
 =========
 
-- :feature:'8' allow addition of palettes and palettes and colours
+.. currentmodule:: colourettu
+
+- :feature:`8` allow addition of palettes, and palettes and colours
 - :support:`-` manage changelog with `Releases <https://github.com/bitprophet/releases>`_
-- :feature:`-` add `palette` class
+- :feature:`-` add :py:class:`palette` class
 - :feature:`-` allow creation of colours from normalized rgb values
 - :support:`-` update to Sphinx 1.3 for documentation generation
 
@@ -15,4 +17,4 @@ Changelog
 - :bug:`-` include extra files so module can install off of pip
 - :release:`0.1.0 <2014-12-11>`
 - :feature:`-` first working version!
-- :feature:`-` base `colour` class, and (relative) `luminance` and `contrast` functions
+- :feature:`-` base :py:class:`colour` class, and (relative) :py:func:`luminance` and :py:func:`contrast` functions
diff --git a/docs/class-colour.rst b/docs/class-colour.rst
@@ -0,0 +1,6 @@
+*colour* class
+==============
+
+.. currentmodule:: colourettu
+
+.. autoclass:: colour
diff --git a/docs/class-palette.rst b/docs/class-palette.rst
@@ -0,0 +1,6 @@
+*palette* class
+===============
+
+.. currentmodule:: colourettu
+
+.. autoclass:: palette
diff --git a/docs/conf.py b/docs/conf.py
@@ -62,7 +62,7 @@
 # General information about the project.
 project = 'Colourettu'
 year = datetime.now().year
-year = str(year)[:-2]
+year = str(year)[-2:]
 copyright = '2014-{}, William Minchin'.format(year)
 
 # The version info for the project you're documenting, acts as replacement for

diff --git a/docs/function-contrast.rst b/docs/function-contrast.rst
@@ -0,0 +1,6 @@
+*contrast* function
+===================
+
+.. currentmodule:: colourettu
+
+.. autofunction:: contrast
diff --git a/docs/function-luminance.rst b/docs/function-luminance.rst
@@ -0,0 +1,6 @@
+*luminance* function
+====================
+
+.. currentmodule:: colourettu
+
+.. autofunction:: luminance
diff --git a/docs/index.rst b/docs/index.rst
@@ -20,8 +20,10 @@ Contents
 
 .. toctree::
    :maxdepth: 2
+   :glob:
 
-   module-colourettu
+   class-*
+   function-*
    requirements
    upgrades
    changelog

diff --git a/docs/module-colourettu.rst b/docs/module-colourettu.rst