Skip to content

Commit

Permalink
pretty up the docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
jadolfbr committed Feb 14, 2018
1 parent a469838 commit 9d9352f
Show file tree
Hide file tree
Showing 12 changed files with 27 additions and 25 deletions.
4 changes: 2 additions & 2 deletions docs/apps_pilot_api/apps.pilot.jadolfbr.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
apps.pilot.jadolfbr Apps
========================
apps.pilot.jadolfbr
===================

.. automodule:: apps.pilot.jadolfbr
:members:
Expand Down
5 changes: 2 additions & 3 deletions docs/apps_pilot_api/apps.pilot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ Pilot Apps
:undoc-members:
:show-inheritance:

Apps
----

.. toctree::
:maxdepth: 2

apps.pilot.jadolfbr
4 changes: 2 additions & 2 deletions docs/apps_public_api/apps.public.antibody_benchmark_utils.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
public.antibody\_benchmark\_utils Apps
======================================
public.antibody\_benchmark\_utils
=================================

.. automodule:: apps.public.antibody_benchmark_utils
:members:
Expand Down
4 changes: 2 additions & 2 deletions docs/apps_public_api/apps.public.antibody_utils.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
public.antibody\_utils Apps
===========================
public.antibody\_utils
======================

.. automodule:: apps.public.antibody_utils
:members:
Expand Down
4 changes: 2 additions & 2 deletions docs/apps_public_api/apps.public.general.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
public.general Apps
===================
public.general
==============

.. automodule:: apps.public.general
:members:
Expand Down
4 changes: 2 additions & 2 deletions docs/apps_public_api/apps.public.pdb_utils.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
public.pdb\_utils Apps
======================
public.pdb\_utils
=================

.. automodule:: apps.public.pdb_utils
:members:
Expand Down
5 changes: 2 additions & 3 deletions docs/apps_public_api/apps.public.pyrosetta.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
public.pyrosetta Apps
=====================

public.pyrosetta
================
.. automodule:: apps.public.pyrosetta
:members:
:undoc-members:
Expand Down
4 changes: 2 additions & 2 deletions docs/apps_public_api/apps.public.rosetta.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
public.rosetta Apps
===================
public.rosetta
==============

.. automodule:: apps.public.rosetta
:members:
Expand Down
3 changes: 0 additions & 3 deletions docs/apps_public_api/apps.public.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,6 @@ Public Apps
:undoc-members:
:show-inheritance:

Apps
----

.. toctree::
:maxdepth: 2

Expand Down
8 changes: 7 additions & 1 deletion docs/apps_public_api/modules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@ Public Apps
======

.. toctree::
:maxdepth: 4
:maxdepth: 1

apps.public
apps.public.antibody_benchmark_utils
apps.public.antibody_utils
apps.public.general
apps.public.pdb_utils
apps.public.pyrosetta
apps.public.rosetta
3 changes: 2 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ Contents:

readme
installation
api/modules
apps_public_api/apps.public
apps_pilot_api/apps.pilot
api/modules


Indices and tables
==================
Expand Down
4 changes: 2 additions & 2 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ You can either clone the public repository:

.. code-block:: console
$ git clone git://github.com/jadolfbr/jade
$ git clone git://github.com/SchiefLab/jade
Or download the `tarball`_:

Expand All @@ -53,7 +53,7 @@ Don't forget to source your bashrc/bash_profile or whatever other shell profile
Scripts
=======

All scripts and applications in jade/apps will be installed in your bin directory and available for use.
All scripts and applications in jade/apps will be installed in your bin directory and available for use.


.. _Github repo: https://github.com/SchiefLab/Jade
Expand Down

0 comments on commit 9d9352f

Please sign in to comment.