Update docs/shpinx config

[#OSF-6554]
CenterForOpenScience · Aug 17, 2016 · 141fe5a · 141fe5a
1 parent f653bb6
commit 141fe5a
Show file tree

Hide file tree

Showing 15 changed files with 173 additions and 180 deletions.
diff --git a/docs/api_reference.rst b/docs/api_reference.rst
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -1 +1,5 @@
-.. include:: ../HISTORY.rst
+Change Log
+==========
+
+.. include:: ../CHANGELOG
+   :literal:
diff --git a/docs/code.rst b/docs/code.rst
@@ -0,0 +1,10 @@
+Code
+====
+
+.. toctree::
+    :maxdepth: 2
+
+    core
+    extensions
+    providers
+    server
diff --git a/docs/conf.py b/docs/conf.py
@@ -22,6 +22,8 @@
 
 # -- General configuration -----------------------------------------------------
 
+autodoc_default_flags = ['members', 'undoc-members', 'show-inheritance']
+
 # If your documentation needs a minimal Sphinx version, state it here.
 #needs_sphinx = '1.0'
 
@@ -123,7 +125,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 = ['_static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.

diff --git a/docs/core.rst b/docs/core.rst
@@ -0,0 +1,22 @@
+Core
+====
+
+mfr.core.exceptions
+-------------------
+
+.. automodule:: mfr.core.exceptions
+
+mfr.core.extension
+------------------
+
+.. automodule:: mfr.core.extension
+
+mfr.core.provider
+-----------------
+
+.. automodule:: mfr.core.provider
+
+mfr.core.utils
+-----------------
+
+.. automodule:: mfr.core.utils
diff --git a/docs/examples.rst b/docs/examples.rst
@@ -56,7 +56,7 @@ app.py
 
 view_file.html
 
-.. code-block:: html
+.. code-block:: none
 
     {% for stylesheet in render_result.assets.css %}
         <link rel="stylesheet" href={{ stylesheet }}/>
@@ -65,4 +65,4 @@ view_file.html
         <script type="text/javascript" src={{ javascript }}/>
     {%  endfor %}
 
-    {{ render_result.content|safe }}
+    {{ render_result.content|safe }}
diff --git a/docs/extensions.rst b/docs/extensions.rst
@@ -0,0 +1,58 @@
+Extensions
+==========
+
+AudioRenderer
+-------------
+
+.. autoclass:: mfr.extensions.audio.AudioRenderer
+
+CodePygmentsRenderer
+--------------------
+
+.. autoclass:: mfr.extensions.codepygments.CodePygmentsRenderer
+
+DocxRenderer
+------------
+
+.. autoclass:: mfr.extensions.docx.DocxRenderer
+
+ImageExporter
+-------------
+
+.. autoclass:: mfr.extensions.image.ImageExporter
+
+ImageRenderer
+-------------
+
+.. autoclass:: mfr.extensions.image.ImageRenderer
+
+IpynbRenderer
+-------------
+
+.. autoclass:: mfr.extensions.ipynb.IpynbRenderer
+
+PdbRenderer
+-----------
+**Note**: This module requires jquery on the page in which it is loaded.
+
+.. autoclass:: mfr.extensions.pdb.PdbRenderer
+
+PdfRenderer
+-----------
+
+.. autoclass:: mfr.extensions.pdf.PdfRenderer
+
+RstRenderer
+-----------
+
+.. autoclass:: mfr.extensions.rst.RstRenderer
+
+TabularRenderer
+---------------
+
+.. autoclass:: mfr.extensions.tabular.TabularRenderer
+
+VideoRenderer
+-------------
+
+.. autoclass:: mfr.extensions.video.VideoRenderer
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,7 +1,4 @@
-.. mfr documentation master file, created by
-   sphinx-quickstart on Tue Jul  9 22:26:36 2013.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+.. title:: Modular File Renderer
 
 mfr: HTML file renderer for Python
 ==================================
@@ -21,13 +18,12 @@ Guide
 -----
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
 
-   license
    install
    quickstart
    examples
-   api_reference
+   code
 
 Project info
 ------------
@@ -38,3 +34,4 @@ Project info
    contributing
    authors
    changelog
+   license
diff --git a/docs/install.rst b/docs/install.rst
@@ -14,14 +14,41 @@ Or download one of the following:
 * tarball_
 * zipball_
 
-To install the base requirements, run:
+Make sure that you have installed R, are using python3.5, and have installed invoke for your current python3 version.
 
-    $ pip install -r requirements.txt
+Install the version of invoke found in the requirements.txt file. Currently 0.11.1
 
-Once you have the source and requirements, you can install it into your site-packages with ::
+Install ``invoke``:
 
-    $ python setup.py install
+.. code-block:: bash
+
+    pip install invoke==0.11.1
+
+Install requirements:
+
+.. code-block:: bash
+
+    invoke install
+
+Or for some nicities (like tests):
+
+.. code-block:: bash
+
+    invoke install --develop
+
+Start the server:
+
+.. note
+
+    The server is extremely tenacious thanks to stevedore and tornado
+    Syntax errors in the :mod:`mfr.providers` will not crash the server
+    In debug mode the server will automatically reload
+
+.. code-block:: bash
+
+    invoke server
 
 .. _Github: https://github.com/CenterForOpenScience/modular-file-renderer
 .. _tarball: https://github.com/CenterForOpenScience/modular-file-renderer/tarball/master
 .. _zipball: https://github.com/CenterForOpenScience/modular-file-renderer/zipball/master
+
diff --git a/docs/license.rst b/docs/license.rst
@@ -1 +1,5 @@
-.. include:: ../LICENSE.rst
+Licence
+=======
+
+.. include:: ../LICENSE
+   :literal:
diff --git a/docs/providers.rst b/docs/providers.rst
@@ -0,0 +1,12 @@
+Providers
+=========
+
+mfr.providers.http
+------------------
+
+.. autoclass:: mfr.providers.http.HttpProvider
+
+mfr.providers.osf
+-----------------
+
+.. autoclass:: mfr.providers.osf.OsfProvider
diff --git a/docs/quickstart.rst b/docs/quickstart.rst
@@ -30,7 +30,7 @@ This example is equivalent to above.
 
 RenderResult objects contain the resultant html as content. Any javascript or css assets are contained in a dictionary. To display assets with jinja, simply iterate through the lists.
 
-.. code-block:: html
+.. code-block:: none
 
     {% for stylesheet in render_result.assets.css %}
         <link rel="stylesheet" href={{ stylesheet }}/>

diff --git a/docs/server.rst b/docs/server.rst
@@ -0,0 +1,19 @@
+Server
+======
+
+mfr.server.app
+--------------
+
+.. automodule:: mfr.server.app
+
+mfr.server.handlers
+-------------------
+
+.. automodule:: mfr.server.handlers.core
+
+.. automodule:: mfr.server.handlers.export
+
+.. automodule:: mfr.server.handlers.render
+
+.. automodule:: mfr.server.handlers.status
+