update docs

gboeing · Dec 30, 2020 · 3d0d768 · 3d0d768
1 parent 4336977
commit 3d0d768
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 48 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
-#
+"""Configure pynamical docs."""
 # pynamical documentation build configuration file, created by
 # sphinx-quickstart on Tue Jan 31 13:34:32 2017.
 #
@@ -61,17 +61,13 @@
 
 # General information about the project.
 project = "pynamical"
-copyright = "2020, Geoff Boeing"
+copyright = "2015-2021, Geoff Boeing"
 author = "Geoff Boeing"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
-#
-# The short X.Y version.
-version = "0.2.1"
-# The full version, including alpha/beta/rc tags.
-release = "0.2.1"
+version = release = "0.3.0"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -108,7 +104,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
+html_static_path = []
 
 
 # -- Options for HTMLHelp output ------------------------------------------

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,20 +1,16 @@
-.. pynamical documentation master file, created by
-   sphinx-quickstart on Tue Jan 31 13:34:32 2017.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-pynamical documentation
-=======================
+pynamical |version|
+===================
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
    pynamical
 
-pynamical is a Python package for modeling, simulating, visualizing, and animating discrete nonlinear dynamical systems and chaos. It uses pandas, numpy, and numba for fast simulation, and matplotlib for beautiful visualizations and animations to explore system behavior. Compatible with Python 2 and 3.
+**pynamical** is a Python package for modeling, simulating, visualizing, and animating discrete nonlinear dynamical systems and chaos. It uses pandas, numpy, and numba for fast simulation, and matplotlib for beautiful visualizations and animations to explore system behavior.
+
+**Citation information**: Boeing, G. 2016. "`Visual Analysis of Nonlinear Dynamical Systems: Chaos, Fractals, Self-Similarity and the Limits of Prediction`_." *Systems*, 4 (4), 37. doi:10.3390/systems4040037.
 
-You can read/cite the journal article about pynamical: Boeing, G. 2016. "`Visual Analysis of Nonlinear Dynamical Systems: Chaos, Fractals, Self-Similarity and the Limits of Prediction`_." *Systems*, 4 (4), 37. doi:10.3390/systems4040037.
 
 Installation
 ------------
@@ -23,25 +19,24 @@ You can install pynamical with conda:
 
 .. code-block:: shell
 
-    conda install -c conda-forge pynamical
+    conda config --prepend channels conda-forge
+    conda create -n pynamical --strict-channel-priority jupyterlab pynamical
 
-Alternatively, you can run pynamical + Jupyter directly from this
-`docker container`_, or you can install it with pip:
+Alternatively, you can run pynamical + Jupyter directly from its `Docker container`_, or you can install it with pip.
 
-.. code-block:: shell
 
-    pip install pynamical
-    
 Examples
 --------
 
 For examples and demos, see the GitHub repo: `https://github.com/gboeing/pynamical`_
-
+
+
 Support
 -------
 
 Issue tracker: `https://github.com/gboeing/pynamical/issues`_
 
+
 License
 -------
 

diff --git a/docs/source/modules.rst b/docs/source/modules.rst
diff --git a/docs/source/pynamical.rst b/docs/source/pynamical.rst
@@ -1,22 +1,8 @@
 pynamical package
 =================
 
-Submodules
-----------
-
-pynamical.pynamical module
---------------------------
+pynamical module
+----------------
 
 .. automodule:: pynamical.pynamical
     :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: pynamical
-    :members:
-    :undoc-members:
-    :show-inheritance: