From 8e978d6938b81975e6b5877c9eaa6dd40002f66e Mon Sep 17 00:00:00 2001
From: Nicolas MAILLET <nicolas.maillet@pasteur.fr>
Date: Fri, 27 Apr 2018 15:52:15 +0200
Subject: [PATCH] Correct docs
---
docs/conf.py | 2 +-
docs/index.rst | 16 ++++++++--------
docs/modules.rst | 3 +--
docs/rpg.rst | 8 ++++++++
4 files changed, 18 insertions(+), 11 deletions(-)
diff --git a/docs/conf.py b/docs/conf.py
index 24183c4..d6ffa3f 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -15,7 +15,7 @@
import os
import sys
sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__),
- '../rpg')))
+ '../../rpg')))
# -- Project information -----------------------------------------------------
diff --git a/docs/index.rst b/docs/index.rst
index e683188..e26f3f8 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -8,20 +8,20 @@ RapidPeptidesGenerator (RPG)
.. image:: https://badge.fury.io/py/rpg.svg
-:target: https://badge.fury.io/py/rpg
-:alt: Pypi repo
+ :target: https://badge.fury.io/py/rpg
+ :alt: Pypi repo
.. image:: https://gitlab.pasteur.fr/nmaillet/rpg/badges/master/pipeline.svg
-:target: https://gitlab.pasteur.fr/nmaillet/rpg/commits/master
-:alt: Build Status
+ :target: https://gitlab.pasteur.fr/nmaillet/rpg/commits/master
+ :alt: Build Status
.. image:: https://gitlab.pasteur.fr/nmaillet/rpg/badges/master/coverage.svg
-:target: https://gitlab.pasteur.fr/nmaillet/rpg/commits/master
-:alt: Coverage Report
+ :target: https://gitlab.pasteur.fr/nmaillet/rpg/commits/master
+ :alt: Coverage Report
.. image:: https://readthedocs.org/projects/rapid-peptide-generator/badge/?version=latest
-:target: http://rapid-peptide-generator.readthedocs.io/en/latest/?badge=latest
-:alt: Documentation Status
+ :target: http://rapid-peptide-generator.readthedocs.io/en/latest/?badge=latest
+ :alt: Documentation Status
In silico protein digestion
diff --git a/docs/modules.rst b/docs/modules.rst
index 7cc271c..00fd97b 100644
--- a/docs/modules.rst
+++ b/docs/modules.rst
@@ -1,5 +1,4 @@
-===
-API
+rpg
===
.. toctree::
diff --git a/docs/rpg.rst b/docs/rpg.rst
index 7a38dc5..cab339a 100644
--- a/docs/rpg.rst
+++ b/docs/rpg.rst
@@ -12,6 +12,14 @@ rpg.RapidPeptidesGenerator module
:undoc-members:
:show-inheritance:
+rpg.context module
+------------------
+
+.. automodule:: rpg.context
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
rpg.core module
---------------
--
GitLab