From 337f960c7d46945f55fd5b5036739cdfe4ad8403 Mon Sep 17 00:00:00 2001 From: SteveDevenes Date: Mon, 28 Sep 2020 14:23:32 +0200 Subject: [PATCH] deploy documentation on github pages --- .travis.yml | 11 ++++++++++- docs/Makefile | 1 + docs/source/modules.rst | 2 +- docs/source/{test.rst => paper.rst} | 6 +++--- makefile | 7 ++++++- 5 files changed, 21 insertions(+), 6 deletions(-) rename docs/source/{test.rst => paper.rst} (53%) diff --git a/.travis.yml b/.travis.yml index b5362a3..dbf1179 100644 --- a/.travis.yml +++ b/.travis.yml @@ -19,5 +19,14 @@ install: script: # Run phase of our CI pipeline - make unitTests - # - make doc + - make doc +deploy: + - provider: pages:git + verbose: true + edge: true + token: $GITHUB_TOKEN + local_dir: ./public/ + on: + branch: master + condition: $TRAVIS_PYTHON_VERSION = 3.8 \ No newline at end of file diff --git a/docs/Makefile b/docs/Makefile index 8f4743e..84e336a 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -37,5 +37,6 @@ html: gendocs mkdir -p $(OUTPUTDIR)/html/ cp -R $(BUILDDIR)/html/* $(OUTPUTDIR) @echo "html files copied; the html files are in $(OUTPUTDIR)." + touch $(OUTPUTDIR)/.nojekyll diff --git a/docs/source/modules.rst b/docs/source/modules.rst index 99f0960..e1732b7 100644 --- a/docs/source/modules.rst +++ b/docs/source/modules.rst @@ -8,4 +8,4 @@ scripts analysis database download_data - test + paper diff --git a/docs/source/test.rst b/docs/source/paper.rst similarity index 53% rename from docs/source/test.rst rename to docs/source/paper.rst index 206500f..71f7d15 100644 --- a/docs/source/test.rst +++ b/docs/source/paper.rst @@ -1,7 +1,7 @@ -test module -=========== +paper module +============ -.. automodule:: test +.. automodule:: paper :members: :undoc-members: :show-inheritance: diff --git a/makefile b/makefile index b71bd64..3e6bad7 100644 --- a/makefile +++ b/makefile @@ -14,4 +14,9 @@ unitTests: cleanTests .PHONY: cleanTests cleanTests: - rm -rf "$(TESTDIR)/output" \ No newline at end of file + rm -rf "$(TESTDIR)/output" + +.PHONY: doc +doc: + $(MAKE) -C docs clean + $(MAKE) -C docs html \ No newline at end of file