Mercurial > repos > vimalkumarvelayudhan > riboplot
changeset 15:b78a5ba760b1
Update README, add new sample image
| author | Vimalkumar Velayudhan <vimal@biotechcoder.com> |
|---|---|
| date | Thu, 27 Aug 2015 12:52:48 +0100 |
| parents | 628f82e72d72 |
| children | ef39290c19af |
| files | README.rst docs/conf.py docs/index.rst docs/modules.rst docs/riboplot.rst images/riboplot.png |
| diffstat | 6 files changed, 12 insertions(+), 60 deletions(-) [+] |
line wrap: on
line diff
--- a/README.rst Wed Aug 26 16:37:10 2015 +0100 +++ b/README.rst Thu Aug 27 12:52:48 2015 +0100 @@ -19,8 +19,6 @@ **ribocount** Output read counts for all transcripts in an alignment. -For help on using these programs, please refer to :ref:`usage`. - Free software: GPL license.
--- a/docs/conf.py Wed Aug 26 16:37:10 2015 +0100 +++ b/docs/conf.py Thu Aug 27 12:52:48 2015 +0100 @@ -15,6 +15,17 @@ import sys import os +# To get the docs to build on readthedocs.org +from mock import Mock as MagicMock + +class Mock(MagicMock): + @classmethod + def __getattr__(cls, name): + return Mock() + +MOCK_MODULES = ['matplotlib'] +sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES) + # If extensions (or modules to document with autodoc) are in another # directory, add these directories to sys.path here. If the directory is @@ -40,7 +51,7 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode'] +extensions = ['sphinx.ext.viewcode'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates']
--- a/docs/index.rst Wed Aug 26 16:37:10 2015 +0100 +++ b/docs/index.rst Thu Aug 27 12:52:48 2015 +0100 @@ -19,11 +19,6 @@ authors history -API: - -.. toctree:: - - modules Indices and tables ==================
--- a/docs/modules.rst Wed Aug 26 16:37:10 2015 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,7 +0,0 @@ -riboplot -======== - -.. toctree:: - :maxdepth: 4 - - riboplot
--- a/docs/riboplot.rst Wed Aug 26 16:37:10 2015 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,45 +0,0 @@ -riboplot package -================ - -Submodules ----------- - -riboplot.config module ----------------------- - -.. automodule:: riboplot.config - :members: - :undoc-members: - :show-inheritance: - -riboplot.ribocore module ------------------------- - -.. automodule:: riboplot.ribocore - :members: - :undoc-members: - :show-inheritance: - -riboplot.ribocount module -------------------------- - -.. automodule:: riboplot.ribocount - :members: - :undoc-members: - :show-inheritance: - -riboplot.riboplot module ------------------------- - -.. automodule:: riboplot.riboplot - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: riboplot - :members: - :undoc-members: - :show-inheritance: