DOC: Improve documentation

Add parallel-specific functions to docs
Improve theme

Author: Sheppard, Kevin

.gitignore

@@ -1,7 +1,6 @@
 *.xml
 *.so
 pcg.c
-*.html
 pcg-c-0.94
 *.o
 pcg/core-rng

doc/source/_static/style-changes.css

@@ -0,0 +1,2 @@
+a{color: #180CD2;}
+table a:not(.btn), .table a:not(.btn) {text-decoration: none;}

doc/source/_templates/layout.html

@@ -0,0 +1,5 @@
+{# Import the theme's layout. #}
+{% extends "!layout.html" %}
+
+{# Custom CSS overrides #}
+{% set bootswatch_css_custom = ['_static/style-changes.css'] %}

doc/source/conf.py

@@ -16,6 +16,7 @@
 import sys
 import os
 import shlex
+import sphinx_bootstrap_theme
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -62,9 +63,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0'
+version = '1.10'
 # The full version, including alpha/beta/rc tags.
-release = '.1'
+release = '0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -115,17 +116,20 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+html_theme = 'bootstrap'
+html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
 
-if not on_rtd:  # only import and set the theme if we're building docs locally
-    import sphinx_rtd_theme
-    html_theme = 'sphinx_rtd_theme'
-    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+#on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+#
+#if not on_rtd:  # only import and set the theme if we're building docs locally
+#    import sphinx_rtd_theme
+#    html_theme = 'sphinx_rtd_theme'
+#    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#html_theme_options = {}
+html_theme_options = {'bootswatch_theme': 'flatly'}
 
 # Add any paths that contain custom themes here, relative to this directory.
 #html_theme_path = []

doc/source/pcg32.rst

@@ -16,6 +16,12 @@ Random generator
    get_state
    set_state
 
+Parallel generation
+===================
+.. autosummary::
+   :toctree: generated/
+
+   advance
 
 Simple random data
 ==================

doc/source/pcg64.rst

@@ -16,6 +16,12 @@ Random generator
    get_state
    set_state
 
+Parallel generation
+===================
+.. autosummary::
+   :toctree: generated/
+
+   advance
 
 Simple random data
 ==================

doc/source/xorshift1024.rst

@@ -16,6 +16,12 @@ Random generator
    get_state
    set_state
 
+Parallel generation
+===================
+.. autosummary::
+   :toctree: generated/
+
+   jump
 
 Simple random data
 ==================

doc/source/xorshift128.rst

@@ -16,6 +16,12 @@ Random generator
    get_state
    set_state
 
+Parallel generation
+===================
+.. autosummary::
+   :toctree: generated/
+
+   jump
 
 Simple random data
 ==================