From 1a80b7f2a63afac2997241f2a3103ca448a818eb Mon Sep 17 00:00:00 2001 From: Nicolas MAILLET <nicolas.maillet@pasteur.fr> Date: Fri, 27 Apr 2018 10:19:39 +0200 Subject: [PATCH] simplify docs for rtfd --- docs/Makefile | 2 +- docs/changelog.rst | 1 + docs/{source => }/conf.py | 4 ++-- docs/{source => }/enzymes.rst | 0 docs/{source => }/index.rst | 0 docs/{source => }/modules.rst | 0 docs/readme.rst | 1 + docs/{source => }/rpg.rst | 0 docs/source/changelog.rst | 1 - docs/source/readme.rst | 1 - 10 files changed, 5 insertions(+), 5 deletions(-) create mode 100644 docs/changelog.rst rename docs/{source => }/conf.py (98%) rename docs/{source => }/enzymes.rst (100%) rename docs/{source => }/index.rst (100%) rename docs/{source => }/modules.rst (100%) create mode 100644 docs/readme.rst rename docs/{source => }/rpg.rst (100%) delete mode 100644 docs/source/changelog.rst delete mode 100644 docs/source/readme.rst diff --git a/docs/Makefile b/docs/Makefile index 713be30..482be85 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -5,7 +5,7 @@ SPHINXOPTS = SPHINXBUILD = sphinx-build SPHINXPROJ = RapidPeptidesGenerator -SOURCEDIR = ./source +SOURCEDIR = . BUILDDIR = _build # Put it first so that "make" without argument is like "make help". diff --git a/docs/changelog.rst b/docs/changelog.rst new file mode 100644 index 0000000..4d7817a --- /dev/null +++ b/docs/changelog.rst @@ -0,0 +1 @@ +.. include:: ../CHANGELOG.rst \ No newline at end of file diff --git a/docs/source/conf.py b/docs/conf.py similarity index 98% rename from docs/source/conf.py rename to docs/conf.py index baa3827..24183c4 100644 --- a/docs/source/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 ----------------------------------------------------- @@ -50,7 +50,7 @@ napoleon_use_param = False napoleon_use_ivar = True # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +#templates_path = ['_templates'] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: diff --git a/docs/source/enzymes.rst b/docs/enzymes.rst similarity index 100% rename from docs/source/enzymes.rst rename to docs/enzymes.rst diff --git a/docs/source/index.rst b/docs/index.rst similarity index 100% rename from docs/source/index.rst rename to docs/index.rst diff --git a/docs/source/modules.rst b/docs/modules.rst similarity index 100% rename from docs/source/modules.rst rename to docs/modules.rst diff --git a/docs/readme.rst b/docs/readme.rst new file mode 100644 index 0000000..6b2b3ec --- /dev/null +++ b/docs/readme.rst @@ -0,0 +1 @@ +.. include:: ../README.rst \ No newline at end of file diff --git a/docs/source/rpg.rst b/docs/rpg.rst similarity index 100% rename from docs/source/rpg.rst rename to docs/rpg.rst diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst deleted file mode 100644 index 6f90edd..0000000 --- a/docs/source/changelog.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../CHANGELOG.rst \ No newline at end of file diff --git a/docs/source/readme.rst b/docs/source/readme.rst deleted file mode 100644 index 38ba804..0000000 --- a/docs/source/readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../README.rst \ No newline at end of file -- GitLab