Reorganize whole API documentation (#23, #29)

a5kin · Feb 23, 2018 · 62c1475 · 62c1475
1 parent e530c61
commit 62c1475
Show file tree

Hide file tree

Showing 6 changed files with 47 additions and 54 deletions.
diff --git a/docs/api/xentica.bridge.rst b/docs/api/xentica.bridge.rst
@@ -1,18 +1,18 @@
-xentica\.bridge package
-=======================
+The Bridge (xentica\.bridge)
+============================
 
 .. automodule:: xentica.bridge
 
-xentica\.bridge\.base module
+Base (xentica\.bridge\.base)
 ----------------------------
 
 .. automodule:: xentica.bridge.base
     :members:
     :undoc-members:
     :show-inheritance:
 
-xentica\.bridge\.moire module
------------------------------
+Moire (xentica\.bridge\.moire)
+------------------------------
 
 .. automodule:: xentica.bridge.moire
     :members:

diff --git a/docs/api/xentica.core.rst b/docs/api/xentica.core.rst
@@ -1,76 +1,66 @@
-xentica\.core package
-=====================
+The Core (xentica\.core)
+========================
 
 .. automodule:: xentica.core
 
-Subpackages
------------
-
-.. toctree::
-
-    xentica.core.topology
-
-Submodules
-----------
-
-xentica\.core\.base module
---------------------------
+Base Classes (xentica\.core\.base)
+----------------------------------
 
 .. automodule:: xentica.core.base
     :members:
     :undoc-members:
     :show-inheritance:
 
-xentica\.core\.experiment module
---------------------------------
+Experiments (xentica\.core\.experiment)
+---------------------------------------
 
 .. automodule:: xentica.core.experiment
     :members:
     :undoc-members:
     :show-inheritance:
 
-xentica\.core\.properties module
---------------------------------
+Properties (xentica\.core\.properties)
+--------------------------------------
 
 .. automodule:: xentica.core.properties
     :members:
     :undoc-members:
     :show-inheritance:
 
-xentica\.core\.variables module
--------------------------------
+Variables (xentica\.core\.variables)
+------------------------------------
 
 .. automodule:: xentica.core.variables
     :members:
     :undoc-members:
     :show-inheritance:
 
-xentica\.core\.color\_effects module
-------------------------------------
+Color Effects (xentica\.core\.color\_effects)
+---------------------------------------------
 
 .. automodule:: xentica.core.color_effects
     :members:
     :undoc-members:
     :show-inheritance:
 
-xentica\.core\.renderers module
--------------------------------
+Renderers (xentica\.core\.renderers)
+------------------------------------
 
 .. automodule:: xentica.core.renderers
     :members:
     :undoc-members:
     :show-inheritance:
 
-xentica\.core\.exceptions module
---------------------------------
+Exceptions (xentica\.core\.exceptions)
+--------------------------------------
 
 .. automodule:: xentica.core.exceptions
     :members:
     :undoc-members:
     :show-inheritance:
 
-xentica\.core\.mixins module
-----------------------------
+Mixins (xentica\.core\.mixins)
+------------------------------
 
 .. automodule:: xentica.core.mixins
     :members:

diff --git a/docs/api/xentica.core.topology.rst b/docs/api/xentica.core.topology.rst
@@ -1,34 +1,34 @@
-xentica\.core\.topology
-=======================
+The Topology (xentica\.core\.topology)
+======================================
 
 .. automodule:: xentica.core.topology
 
-xentica\.core\.topology\.lattice
---------------------------------
+Lattice (xentica\.core\.topology\.lattice)
+------------------------------------------
 
 .. automodule:: xentica.core.topology.lattice
     :members:
     :undoc-members:
     :show-inheritance:
 
-xentica\.core\.topology\.neighborhood
--------------------------------------
+Neighborhood (xentica\.core\.topology\.neighborhood)
+----------------------------------------------------
 
 .. automodule:: xentica.core.topology.neighborhood
     :members:
     :undoc-members:
     :show-inheritance:
 
-xentica\.core\.topology\.border
--------------------------------
+Border (xentica\.core\.topology\.border)
+----------------------------------------
 
 .. automodule:: xentica.core.topology.border
     :members:
     :undoc-members:
     :show-inheritance:
 
-xentica\.core\.topology\.mixins
--------------------------------
+Mixins (xentica\.core\.topology\.mixins)
+----------------------------------------
 
 .. automodule:: xentica.core.topology.mixins
     :members:

diff --git a/docs/api/xentica.seeds.rst b/docs/api/xentica.seeds.rst
@@ -1,19 +1,19 @@
-xentica\.seeds package
-======================
+The Seeds (xentica\.seeds)
+==========================
 
 .. automodule:: xentica.seeds
     :members:
 
-xentica\.seeds\.patterns module
--------------------------------
+Patterns (xentica\.seeds\.patterns)
+-----------------------------------
 
 .. automodule:: xentica.seeds.patterns
     :members:
     :undoc-members:
     :show-inheritance:
 
-xentica\.seeds\.random module
------------------------------
+RNG (xentica\.seeds\.random)
+----------------------------
 
 .. automodule:: xentica.seeds.random
     :members:

diff --git a/docs/api/xentica.utils.rst b/docs/api/xentica.utils.rst
@@ -1,10 +1,10 @@
-xentica\.utils package
-======================
+Utilities (xentica\.utils)
+==========================
 
 .. automodule:: xentica.utils
 
-xentica\.utils\.formatters module
----------------------------------
+Formatters (xentica\.utils\.formatters)
+---------------------------------------
 
 .. automodule:: xentica.utils.formatters
     :members:

diff --git a/docs/index.rst b/docs/index.rst
@@ -19,7 +19,7 @@ User Guide
 If you brave enough to ignore the warning above, dive right into this
 guide. Hopefully, you will manage to install Xentica on your system
 and at least run some examples. Otherwise, just read Tutorial and
-watch some videos to decide is it worth waiting for future versions.
+watch some `videos`_ to decide is it worth waiting for future versions.
 
 .. toctree::
    :maxdepth: 2
@@ -34,6 +34,7 @@ API Reference
    :maxdepth: 2
 
    api/xentica.core
+   api/xentica.core.topology
    api/xentica.seeds
    api/xentica.bridge
    api/xentica.utils
@@ -44,3 +45,5 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
+
+.. _videos: https://www.youtube.com/channel/UC0qUBlSKg_6g8Qzg8JLTPaA