Update documentation files.

colour-science · Jul 11, 2017 · f906ecf · f906ecf
1 parent 9070c23
commit f906ecf
Show file tree

Hide file tree

Showing 215 changed files with 502 additions and 406 deletions.
diff --git a/colour/colorimetry/tristimulus.py b/colour/colorimetry/tristimulus.py
@@ -65,7 +65,7 @@
 
 ASTME30815_PRACTISE_SHAPE = DEFAULT_SPECTRAL_SHAPE
 """
-*ASTM E308–15* practise shape: (360, 780, 1).
+*ASTM E308-15* practise shape: (360, 780, 1).
 
 ASTME30815_PRACTISE_SHAPE : SpectralShape
 """

diff --git a/colour/colorimetry/yellowness.py b/colour/colorimetry/yellowness.py
@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 """
 Yellowness Index :math:`Y`
-=========================
+==========================
 
 Defines *yellowness* index :math:`Y` computation objects:
 

diff --git a/docs/colour.adaptation.cie1994.rst b/docs/colour.adaptation.cie1994.rst
@@ -1,5 +1,5 @@
-colour.adaptation.cie1994 Module
-================================
+colour\.adaptation\.cie1994 Module
+==================================
 
 .. automodule:: colour.adaptation.cie1994
     :members:

diff --git a/docs/colour.adaptation.cmccat2000.rst b/docs/colour.adaptation.cmccat2000.rst
@@ -1,5 +1,5 @@
-colour.adaptation.cmccat2000 Module
-===================================
+colour\.adaptation\.cmccat2000 Module
+=====================================
 
 .. automodule:: colour.adaptation.cmccat2000
     :members:

diff --git a/docs/colour.adaptation.dataset.cat.rst b/docs/colour.adaptation.dataset.cat.rst
@@ -1,5 +1,5 @@
-colour.adaptation.dataset.cat Module
-====================================
+colour\.adaptation\.dataset\.cat Module
+=======================================
 
 .. automodule:: colour.adaptation.dataset.cat
     :members:

diff --git a/docs/colour.adaptation.dataset.rst b/docs/colour.adaptation.dataset.rst
@@ -1,5 +1,5 @@
-colour.adaptation.dataset Package
-=================================
+colour\.adaptation\.dataset Package
+===================================
 
 Sub-Modules
 -----------

diff --git a/docs/colour.adaptation.fairchild1990.rst b/docs/colour.adaptation.fairchild1990.rst
@@ -1,5 +1,5 @@
-colour.adaptation.fairchild1990 Module
-======================================
+colour\.adaptation\.fairchild1990 Module
+========================================
 
 .. automodule:: colour.adaptation.fairchild1990
     :members:

diff --git a/docs/colour.adaptation.rst b/docs/colour.adaptation.rst
@@ -1,5 +1,5 @@
-colour.adaptation Package
-=========================
+colour\.adaptation Package
+==========================
 
 Sub-Packages
 ------------

diff --git a/docs/colour.adaptation.vonkries.rst b/docs/colour.adaptation.vonkries.rst
@@ -1,5 +1,5 @@
-colour.adaptation.vonkries Module
-=================================
+colour\.adaptation\.vonkries Module
+===================================
 
 .. automodule:: colour.adaptation.vonkries
     :members:

diff --git a/docs/colour.algebra.coordinates.rst b/docs/colour.algebra.coordinates.rst
@@ -1,5 +1,5 @@
-colour.algebra.coordinates Package
-==================================
+colour\.algebra\.coordinates Package
+====================================
 
 Sub-Modules
 -----------

diff --git a/docs/colour.algebra.coordinates.transformations.rst b/docs/colour.algebra.coordinates.transformations.rst
@@ -1,5 +1,5 @@
-colour.algebra.coordinates.transformations Module
-=================================================
+colour\.algebra\.coordinates\.transformations Module
+====================================================
 
 .. automodule:: colour.algebra.coordinates.transformations
     :members:

diff --git a/docs/colour.algebra.extrapolation.rst b/docs/colour.algebra.extrapolation.rst
@@ -1,5 +1,5 @@
-colour.algebra.extrapolation Module
-===================================
+colour\.algebra\.extrapolation Module
+=====================================
 
 .. automodule:: colour.algebra.extrapolation
     :members:

diff --git a/docs/colour.algebra.geometry.rst b/docs/colour.algebra.geometry.rst
@@ -1,5 +1,5 @@
-colour.algebra.geometry Module
-==============================
+colour\.algebra\.geometry Module
+================================
 
 .. automodule:: colour.algebra.geometry
     :members:

diff --git a/docs/colour.algebra.interpolation.rst b/docs/colour.algebra.interpolation.rst
@@ -1,5 +1,5 @@
-colour.algebra.interpolation Module
-===================================
+colour\.algebra\.interpolation Module
+=====================================
 
 .. automodule:: colour.algebra.interpolation
     :members:

diff --git a/docs/colour.algebra.matrix.rst b/docs/colour.algebra.matrix.rst
@@ -1,5 +1,5 @@
-colour.algebra.matrix Module
-============================
+colour\.algebra\.matrix Module
+==============================
 
 .. automodule:: colour.algebra.matrix
     :members:

diff --git a/docs/colour.algebra.random.rst b/docs/colour.algebra.random.rst
@@ -1,5 +1,5 @@
-colour.algebra.random Module
-============================
+colour\.algebra\.random Module
+==============================
 
 .. automodule:: colour.algebra.random
     :members:

diff --git a/docs/colour.algebra.rst b/docs/colour.algebra.rst
@@ -1,5 +1,5 @@
-colour.algebra Package
-======================
+colour\.algebra Package
+=======================
 
 Sub-Packages
 ------------

diff --git a/docs/colour.appearance.atd95.rst b/docs/colour.appearance.atd95.rst
@@ -1,5 +1,5 @@
-colour.appearance.atd95 Module
-==============================
+colour\.appearance\.atd95 Module
+================================
 
 .. automodule:: colour.appearance.atd95
     :members:

diff --git a/docs/colour.appearance.ciecam02.rst b/docs/colour.appearance.ciecam02.rst
@@ -1,5 +1,5 @@
-colour.appearance.ciecam02 Module
-=================================
+colour\.appearance\.ciecam02 Module
+===================================
 
 .. automodule:: colour.appearance.ciecam02
     :members:

diff --git a/docs/colour.appearance.hunt.rst b/docs/colour.appearance.hunt.rst
@@ -1,5 +1,5 @@
-colour.appearance.hunt Module
-=============================
+colour\.appearance\.hunt Module
+===============================
 
 .. automodule:: colour.appearance.hunt
     :members:

diff --git a/docs/colour.appearance.llab.rst b/docs/colour.appearance.llab.rst
@@ -1,5 +1,5 @@
-colour.appearance.llab Module
-=============================
+colour\.appearance\.llab Module
+===============================
 
 .. automodule:: colour.appearance.llab
     :members:

diff --git a/docs/colour.appearance.nayatani95.rst b/docs/colour.appearance.nayatani95.rst
@@ -1,5 +1,5 @@
-colour.appearance.nayatani95 Module
-===================================
+colour\.appearance\.nayatani95 Module
+=====================================
 
 .. automodule:: colour.appearance.nayatani95
     :members:

diff --git a/docs/colour.appearance.rlab.rst b/docs/colour.appearance.rlab.rst
@@ -1,5 +1,5 @@
-colour.appearance.rlab Module
-=============================
+colour\.appearance\.rlab Module
+===============================
 
 .. automodule:: colour.appearance.rlab
     :members:

diff --git a/docs/colour.appearance.rst b/docs/colour.appearance.rst
@@ -1,5 +1,5 @@
-colour.appearance Package
-=========================
+colour\.appearance Package
+==========================
 
 Sub-Modules
 -----------

diff --git a/docs/colour.biochemistry.michaelis_menten.rst b/docs/colour.biochemistry.michaelis_menten.rst
@@ -0,0 +1,7 @@
+colour\.biochemistry\.michaelis\_menten Module
+==============================================
+
+.. automodule:: colour.biochemistry.michaelis_menten
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/colour.biochemistry.rst b/docs/colour.biochemistry.rst
@@ -0,0 +1,17 @@
+colour\.biochemistry Package
+============================
+
+Sub-Modules
+-----------
+
+.. toctree::
+
+   colour.biochemistry.michaelis_menten
+
+Module Contents
+---------------
+
+.. automodule:: colour.biochemistry
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/colour.characterisation.cameras.rst b/docs/colour.characterisation.cameras.rst
@@ -1,5 +1,5 @@
-colour.characterisation.cameras Module
-======================================
+colour\.characterisation\.cameras Module
+========================================
 
 .. automodule:: colour.characterisation.cameras
     :members:

diff --git a/docs/colour.characterisation.dataset.cameras.dslr.rst b/docs/colour.characterisation.dataset.cameras.dslr.rst
@@ -1,5 +1,5 @@
-colour.characterisation.dataset.cameras.dslr Package
-====================================================
+colour\.characterisation\.dataset\.cameras\.dslr Package
+========================================================
 
 Sub-Modules
 -----------

diff --git a/docs/colour.characterisation.dataset.cameras.dslr.spectral_sensitivities.rst b/docs/colour.characterisation.dataset.cameras.dslr.spectral_sensitivities.rst
@@ -1,5 +1,5 @@
-colour.characterisation.dataset.cameras.dslr.spectral_sensitivities Module
-==========================================================================
+colour\.characterisation\.dataset\.cameras\.dslr\.spectral\_sensitivities Module
+================================================================================
 
 .. automodule:: colour.characterisation.dataset.cameras.dslr.spectral_sensitivities
     :members:

diff --git a/docs/colour.characterisation.dataset.cameras.rst b/docs/colour.characterisation.dataset.cameras.rst
@@ -1,5 +1,5 @@
-colour.characterisation.dataset.cameras Package
-===============================================
+colour\.characterisation\.dataset\.cameras Package
+==================================================
 
 Sub-Packages
 ------------

diff --git a/docs/colour.characterisation.dataset.colour_checkers.chromaticity_coordinates.rst b/docs/colour.characterisation.dataset.colour_checkers.chromaticity_coordinates.rst
@@ -1,5 +1,5 @@
-colour.characterisation.dataset.colour_checkers.chromaticity_coordinates Module
-===============================================================================
+colour\.characterisation\.dataset\.colour\_checkers\.chromaticity\_coordinates Module
+=====================================================================================
 
 .. automodule:: colour.characterisation.dataset.colour_checkers.chromaticity_coordinates
     :members:

diff --git a/docs/colour.characterisation.dataset.colour_checkers.rst b/docs/colour.characterisation.dataset.colour_checkers.rst
@@ -1,5 +1,5 @@
-colour.characterisation.dataset.colour_checkers Package
-=======================================================
+colour\.characterisation\.dataset\.colour\_checkers Package
+===========================================================
 
 Sub-Modules
 -----------

diff --git a/docs/colour.characterisation.dataset.colour_checkers.spds.rst b/docs/colour.characterisation.dataset.colour_checkers.spds.rst
@@ -1,5 +1,5 @@
-colour.characterisation.dataset.colour_checkers.spds Module
-===========================================================
+colour\.characterisation\.dataset\.colour\_checkers\.spds Module
+================================================================
 
 .. automodule:: colour.characterisation.dataset.colour_checkers.spds
     :members:

diff --git a/docs/colour.characterisation.dataset.displays.crt.rgb_primaries.rst b/docs/colour.characterisation.dataset.displays.crt.rgb_primaries.rst
@@ -1,5 +1,5 @@
-colour.characterisation.dataset.displays.crt.rgb_primaries Module
-=================================================================
+colour\.characterisation\.dataset\.displays\.crt\.rgb\_primaries Module
+=======================================================================
 
 .. automodule:: colour.characterisation.dataset.displays.crt.rgb_primaries
     :members:

diff --git a/docs/colour.characterisation.dataset.displays.crt.rst b/docs/colour.characterisation.dataset.displays.crt.rst
@@ -1,5 +1,5 @@
-colour.characterisation.dataset.displays.crt Package
-====================================================
+colour\.characterisation\.dataset\.displays\.crt Package
+========================================================
 
 Sub-Modules
 -----------

diff --git a/docs/colour.characterisation.dataset.displays.lcd.rgb_primaries.rst b/docs/colour.characterisation.dataset.displays.lcd.rgb_primaries.rst
@@ -1,5 +1,5 @@
-colour.characterisation.dataset.displays.lcd.rgb_primaries Module
-=================================================================
+colour\.characterisation\.dataset\.displays\.lcd\.rgb\_primaries Module
+=======================================================================
 
 .. automodule:: colour.characterisation.dataset.displays.lcd.rgb_primaries
     :members:

diff --git a/docs/colour.characterisation.dataset.displays.lcd.rst b/docs/colour.characterisation.dataset.displays.lcd.rst
@@ -1,5 +1,5 @@
-colour.characterisation.dataset.displays.lcd Package
-====================================================
+colour\.characterisation\.dataset\.displays\.lcd Package
+========================================================
 
 Sub-Modules
 -----------

diff --git a/docs/colour.characterisation.dataset.displays.rst b/docs/colour.characterisation.dataset.displays.rst
@@ -1,5 +1,5 @@
-colour.characterisation.dataset.displays Package
-================================================
+colour\.characterisation\.dataset\.displays Package
+===================================================
 
 Sub-Packages
 ------------

diff --git a/docs/colour.characterisation.dataset.rst b/docs/colour.characterisation.dataset.rst
@@ -1,5 +1,5 @@
-colour.characterisation.dataset Package
-=======================================
+colour\.characterisation\.dataset Package
+=========================================
 
 Sub-Packages
 ------------

diff --git a/docs/colour.characterisation.displays.rst b/docs/colour.characterisation.displays.rst
@@ -1,5 +1,5 @@
-colour.characterisation.displays Module
-=======================================
+colour\.characterisation\.displays Module
+=========================================
 
 .. automodule:: colour.characterisation.displays
     :members:

diff --git a/docs/colour.characterisation.fitting.rst b/docs/colour.characterisation.fitting.rst
@@ -1,5 +1,5 @@
-colour.characterisation.fitting Module
-======================================
+colour\.characterisation\.fitting Module
+========================================
 
 .. automodule:: colour.characterisation.fitting
     :members:

diff --git a/docs/colour.characterisation.rst b/docs/colour.characterisation.rst
@@ -1,5 +1,5 @@
-colour.characterisation Package
-===============================
+colour\.characterisation Package
+================================
 
 Sub-Packages
 ------------

diff --git a/docs/colour.colorimetry.blackbody.rst b/docs/colour.colorimetry.blackbody.rst
@@ -1,5 +1,5 @@
-colour.colorimetry.blackbody Module
-===================================
+colour\.colorimetry\.blackbody Module
+=====================================
 
 .. automodule:: colour.colorimetry.blackbody
     :members:

diff --git a/docs/colour.colorimetry.cmfs.rst b/docs/colour.colorimetry.cmfs.rst
@@ -1,5 +1,5 @@
-colour.colorimetry.cmfs Module
-==============================
+colour\.colorimetry\.cmfs Module
+================================
 
 .. automodule:: colour.colorimetry.cmfs
     :members:

diff --git a/docs/colour.colorimetry.correction.rst b/docs/colour.colorimetry.correction.rst
@@ -1,5 +1,5 @@
-colour.colorimetry.correction Module
-====================================
+colour\.colorimetry\.correction Module
+======================================
 
 .. automodule:: colour.colorimetry.correction
     :members:

diff --git a/docs/colour.colorimetry.dataset.cmfs.rst b/docs/colour.colorimetry.dataset.cmfs.rst
@@ -1,5 +1,5 @@
-colour.colorimetry.dataset.cmfs Module
-======================================
+colour\.colorimetry\.dataset\.cmfs Module
+=========================================
 
 .. automodule:: colour.colorimetry.dataset.cmfs
     :members:

diff --git a/docs/colour.colorimetry.dataset.illuminants.chromaticity_coordinates.rst b/docs/colour.colorimetry.dataset.illuminants.chromaticity_coordinates.rst
@@ -1,5 +1,5 @@
-colour.colorimetry.dataset.illuminants.chromaticity_coordinates Module
-======================================================================
+colour\.colorimetry\.dataset\.illuminants\.chromaticity\_coordinates Module
+===========================================================================
 
 .. automodule:: colour.colorimetry.dataset.illuminants.chromaticity_coordinates
     :members:

diff --git a/docs/colour.colorimetry.dataset.illuminants.d_illuminants_s_spds.rst b/docs/colour.colorimetry.dataset.illuminants.d_illuminants_s_spds.rst
@@ -1,5 +1,5 @@
-colour.colorimetry.dataset.illuminants.d_illuminants_s_spds Module
-==================================================================
+colour\.colorimetry\.dataset\.illuminants\.d\_illuminants\_s\_spds Module
+=========================================================================
 
 .. automodule:: colour.colorimetry.dataset.illuminants.d_illuminants_s_spds
     :members: