From 0d9383c469d2bd617cdf65210fa68e264497acc8 Mon Sep 17 00:00:00 2001 From: Hubert Date: Tue, 15 Dec 2015 14:44:19 +0100 Subject: [PATCH] Rename documentation folder. Change also the project name in the sphinx parameters. --- .travis.yml | 4 ++-- {doc-api => doc}/Makefile | 0 {doc-api => doc}/make.bat | 0 {doc-api => doc}/source/Fontmap.GS | 0 {doc-api => doc}/source/PBassign.rst | 0 {doc-api => doc}/source/PBclust.rst | 0 {doc-api => doc}/source/PBcount.rst | 0 {doc-api => doc}/source/PBstat.rst | 0 {doc-api => doc}/source/_static/empty | 0 {doc-api => doc}/source/build.sh | 0 {doc-api => doc}/source/conf.py | 2 +- {doc-api => doc}/source/img/1AY7_B.jpg | Bin {doc-api => doc}/source/img/Neq.jpg | Bin {doc-api => doc}/source/img/PBs.jpg | Bin .../source/img/psi_md_traj_all.PB.Neq.jpg | Bin .../source/img/psi_md_traj_all.PB.logo.jpg | Bin .../source/img/psi_md_traj_all.PB.map.jpg | Bin .../img/psi_md_traj_all_frame.PB.Neq.15-42.jpg | Bin .../img/psi_md_traj_all_frame.PB.logo.15-42.jpg | Bin .../img/psi_md_traj_all_frame.PB.map.15-42.jpg | Bin {doc-api => doc}/source/index.rst | 0 {doc-api => doc}/source/install_pandoc.sh | 0 {doc-api => doc}/source/installation.rst | 0 {doc-api => doc}/source/intro_PB.rst | 0 {doc-api => doc}/source/notebooks/Assignement.ipynb | 0 .../source/notebooks/Deformability.ipynb | 0 {doc-api => doc}/source/notebooks/WritePB.ipynb | 0 {doc-api => doc}/source/pages/PB.rst | 0 {doc-api => doc}/source/pages/analysis.rst | 0 {doc-api => doc}/source/pages/assign.rst | 0 {doc-api => doc}/source/pages/demo.rst | 0 {doc-api => doc}/source/pages/io.rst | 0 {doc-api => doc}/source/pages/pbxplore.rst | 0 {doc-api => doc}/source/pages/structure.rst | 0 {doc-api => doc}/source/pandoc_fix_img.py | 0 {doc-api => doc}/source/utilization.rst | 0 36 files changed, 3 insertions(+), 3 deletions(-) rename {doc-api => doc}/Makefile (100%) rename {doc-api => doc}/make.bat (100%) rename {doc-api => doc}/source/Fontmap.GS (100%) rename {doc-api => doc}/source/PBassign.rst (100%) rename {doc-api => doc}/source/PBclust.rst (100%) rename {doc-api => doc}/source/PBcount.rst (100%) rename {doc-api => doc}/source/PBstat.rst (100%) rename {doc-api => doc}/source/_static/empty (100%) rename {doc-api => doc}/source/build.sh (100%) rename {doc-api => doc}/source/conf.py (99%) rename {doc-api => doc}/source/img/1AY7_B.jpg (100%) rename {doc-api => doc}/source/img/Neq.jpg (100%) rename {doc-api => doc}/source/img/PBs.jpg (100%) rename {doc-api => doc}/source/img/psi_md_traj_all.PB.Neq.jpg (100%) rename {doc-api => doc}/source/img/psi_md_traj_all.PB.logo.jpg (100%) rename {doc-api => doc}/source/img/psi_md_traj_all.PB.map.jpg (100%) rename {doc-api => doc}/source/img/psi_md_traj_all_frame.PB.Neq.15-42.jpg (100%) rename {doc-api => doc}/source/img/psi_md_traj_all_frame.PB.logo.15-42.jpg (100%) rename {doc-api => doc}/source/img/psi_md_traj_all_frame.PB.map.15-42.jpg (100%) rename {doc-api => doc}/source/index.rst (100%) rename {doc-api => doc}/source/install_pandoc.sh (100%) rename {doc-api => doc}/source/installation.rst (100%) rename {doc-api => doc}/source/intro_PB.rst (100%) rename {doc-api => doc}/source/notebooks/Assignement.ipynb (100%) rename {doc-api => doc}/source/notebooks/Deformability.ipynb (100%) rename {doc-api => doc}/source/notebooks/WritePB.ipynb (100%) rename {doc-api => doc}/source/pages/PB.rst (100%) rename {doc-api => doc}/source/pages/analysis.rst (100%) rename {doc-api => doc}/source/pages/assign.rst (100%) rename {doc-api => doc}/source/pages/demo.rst (100%) rename {doc-api => doc}/source/pages/io.rst (100%) rename {doc-api => doc}/source/pages/pbxplore.rst (100%) rename {doc-api => doc}/source/pages/structure.rst (100%) rename {doc-api => doc}/source/pandoc_fix_img.py (100%) rename {doc-api => doc}/source/utilization.rst (100%) diff --git a/.travis.yml b/.travis.yml index 48c184c..5bb9d5c 100644 --- a/.travis.yml +++ b/.travis.yml @@ -60,7 +60,7 @@ install: - if [[ $TRAVIS_PYTHON_VERSION == 2.7 ]]; then pip install "mdanalysis>=0.11" --cache-dir $HOME/.cache/pip; fi - pip install -e . - if [[ $SETUP == 'doc' ]]; then pip install -r doc_requirements.txt --cache-dir $HOME/.cache/pip; fi - - if [[ $SETUP == 'doc' ]]; then ./doc-api/source/install_pandoc.sh; fi + - if [[ $SETUP == 'doc' ]]; then ./doc/source/install_pandoc.sh; fi # command to run tests @@ -69,6 +69,6 @@ script: - if [[ $SETUP == 'test' ]]; then yes | ./run_demo1_assignation.sh; fi - if [[ $SETUP == 'test' ]]; then yes | ./run_demo2_statistics.sh; fi - if [[ $SETUP == 'test' ]]; then yes | ./run_demo2_clusters.sh; fi - - if [[ $SETUP == 'doc' ]]; then cd doc-api; sphinx-build -W -b html source build/html; fi + - if [[ $SETUP == 'doc' ]]; then cd doc; sphinx-build -W -b html source build/html; fi #after_success: diff --git a/doc-api/Makefile b/doc/Makefile similarity index 100% rename from doc-api/Makefile rename to doc/Makefile diff --git a/doc-api/make.bat b/doc/make.bat similarity index 100% rename from doc-api/make.bat rename to doc/make.bat diff --git a/doc-api/source/Fontmap.GS b/doc/source/Fontmap.GS similarity index 100% rename from doc-api/source/Fontmap.GS rename to doc/source/Fontmap.GS diff --git a/doc-api/source/PBassign.rst b/doc/source/PBassign.rst similarity index 100% rename from doc-api/source/PBassign.rst rename to doc/source/PBassign.rst diff --git a/doc-api/source/PBclust.rst b/doc/source/PBclust.rst similarity index 100% rename from doc-api/source/PBclust.rst rename to doc/source/PBclust.rst diff --git a/doc-api/source/PBcount.rst b/doc/source/PBcount.rst similarity index 100% rename from doc-api/source/PBcount.rst rename to doc/source/PBcount.rst diff --git a/doc-api/source/PBstat.rst b/doc/source/PBstat.rst similarity index 100% rename from doc-api/source/PBstat.rst rename to doc/source/PBstat.rst diff --git a/doc-api/source/_static/empty b/doc/source/_static/empty similarity index 100% rename from doc-api/source/_static/empty rename to doc/source/_static/empty diff --git a/doc-api/source/build.sh b/doc/source/build.sh similarity index 100% rename from doc-api/source/build.sh rename to doc/source/build.sh diff --git a/doc-api/source/conf.py b/doc/source/conf.py similarity index 99% rename from doc-api/source/conf.py rename to doc/source/conf.py index f821daf..e0d1257 100644 --- a/doc-api/source/conf.py +++ b/doc/source/conf.py @@ -54,7 +54,7 @@ master_doc = 'index' # General information about the project. -project = u'PBxplore API' +project = u'PBxplore' copyright = u'2015, Pierre Poulain, and Alexandre G. deBrevern' # The version info for the project you're documenting, acts as replacement for diff --git a/doc-api/source/img/1AY7_B.jpg b/doc/source/img/1AY7_B.jpg similarity index 100% rename from doc-api/source/img/1AY7_B.jpg rename to doc/source/img/1AY7_B.jpg diff --git a/doc-api/source/img/Neq.jpg b/doc/source/img/Neq.jpg similarity index 100% rename from doc-api/source/img/Neq.jpg rename to doc/source/img/Neq.jpg diff --git a/doc-api/source/img/PBs.jpg b/doc/source/img/PBs.jpg similarity index 100% rename from doc-api/source/img/PBs.jpg rename to doc/source/img/PBs.jpg diff --git a/doc-api/source/img/psi_md_traj_all.PB.Neq.jpg b/doc/source/img/psi_md_traj_all.PB.Neq.jpg similarity index 100% rename from doc-api/source/img/psi_md_traj_all.PB.Neq.jpg rename to doc/source/img/psi_md_traj_all.PB.Neq.jpg diff --git a/doc-api/source/img/psi_md_traj_all.PB.logo.jpg b/doc/source/img/psi_md_traj_all.PB.logo.jpg similarity index 100% rename from doc-api/source/img/psi_md_traj_all.PB.logo.jpg rename to doc/source/img/psi_md_traj_all.PB.logo.jpg diff --git a/doc-api/source/img/psi_md_traj_all.PB.map.jpg b/doc/source/img/psi_md_traj_all.PB.map.jpg similarity index 100% rename from doc-api/source/img/psi_md_traj_all.PB.map.jpg rename to doc/source/img/psi_md_traj_all.PB.map.jpg diff --git a/doc-api/source/img/psi_md_traj_all_frame.PB.Neq.15-42.jpg b/doc/source/img/psi_md_traj_all_frame.PB.Neq.15-42.jpg similarity index 100% rename from doc-api/source/img/psi_md_traj_all_frame.PB.Neq.15-42.jpg rename to doc/source/img/psi_md_traj_all_frame.PB.Neq.15-42.jpg diff --git a/doc-api/source/img/psi_md_traj_all_frame.PB.logo.15-42.jpg b/doc/source/img/psi_md_traj_all_frame.PB.logo.15-42.jpg similarity index 100% rename from doc-api/source/img/psi_md_traj_all_frame.PB.logo.15-42.jpg rename to doc/source/img/psi_md_traj_all_frame.PB.logo.15-42.jpg diff --git a/doc-api/source/img/psi_md_traj_all_frame.PB.map.15-42.jpg b/doc/source/img/psi_md_traj_all_frame.PB.map.15-42.jpg similarity index 100% rename from doc-api/source/img/psi_md_traj_all_frame.PB.map.15-42.jpg rename to doc/source/img/psi_md_traj_all_frame.PB.map.15-42.jpg diff --git a/doc-api/source/index.rst b/doc/source/index.rst similarity index 100% rename from doc-api/source/index.rst rename to doc/source/index.rst diff --git a/doc-api/source/install_pandoc.sh b/doc/source/install_pandoc.sh similarity index 100% rename from doc-api/source/install_pandoc.sh rename to doc/source/install_pandoc.sh diff --git a/doc-api/source/installation.rst b/doc/source/installation.rst similarity index 100% rename from doc-api/source/installation.rst rename to doc/source/installation.rst diff --git a/doc-api/source/intro_PB.rst b/doc/source/intro_PB.rst similarity index 100% rename from doc-api/source/intro_PB.rst rename to doc/source/intro_PB.rst diff --git a/doc-api/source/notebooks/Assignement.ipynb b/doc/source/notebooks/Assignement.ipynb similarity index 100% rename from doc-api/source/notebooks/Assignement.ipynb rename to doc/source/notebooks/Assignement.ipynb diff --git a/doc-api/source/notebooks/Deformability.ipynb b/doc/source/notebooks/Deformability.ipynb similarity index 100% rename from doc-api/source/notebooks/Deformability.ipynb rename to doc/source/notebooks/Deformability.ipynb diff --git a/doc-api/source/notebooks/WritePB.ipynb b/doc/source/notebooks/WritePB.ipynb similarity index 100% rename from doc-api/source/notebooks/WritePB.ipynb rename to doc/source/notebooks/WritePB.ipynb diff --git a/doc-api/source/pages/PB.rst b/doc/source/pages/PB.rst similarity index 100% rename from doc-api/source/pages/PB.rst rename to doc/source/pages/PB.rst diff --git a/doc-api/source/pages/analysis.rst b/doc/source/pages/analysis.rst similarity index 100% rename from doc-api/source/pages/analysis.rst rename to doc/source/pages/analysis.rst diff --git a/doc-api/source/pages/assign.rst b/doc/source/pages/assign.rst similarity index 100% rename from doc-api/source/pages/assign.rst rename to doc/source/pages/assign.rst diff --git a/doc-api/source/pages/demo.rst b/doc/source/pages/demo.rst similarity index 100% rename from doc-api/source/pages/demo.rst rename to doc/source/pages/demo.rst diff --git a/doc-api/source/pages/io.rst b/doc/source/pages/io.rst similarity index 100% rename from doc-api/source/pages/io.rst rename to doc/source/pages/io.rst diff --git a/doc-api/source/pages/pbxplore.rst b/doc/source/pages/pbxplore.rst similarity index 100% rename from doc-api/source/pages/pbxplore.rst rename to doc/source/pages/pbxplore.rst diff --git a/doc-api/source/pages/structure.rst b/doc/source/pages/structure.rst similarity index 100% rename from doc-api/source/pages/structure.rst rename to doc/source/pages/structure.rst diff --git a/doc-api/source/pandoc_fix_img.py b/doc/source/pandoc_fix_img.py similarity index 100% rename from doc-api/source/pandoc_fix_img.py rename to doc/source/pandoc_fix_img.py diff --git a/doc-api/source/utilization.rst b/doc/source/utilization.rst similarity index 100% rename from doc-api/source/utilization.rst rename to doc/source/utilization.rst