From 92c3e1d3b6dc71a399e36bb582760f4bfa54e0a5 Mon Sep 17 00:00:00 2001 From: Lucy Liu Date: Wed, 4 Mar 2020 15:18:02 +0100 Subject: [PATCH 01/11] first attempt, gh action --- .github/workflows/sphinx_build.yml | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 .github/workflows/sphinx_build.yml diff --git a/.github/workflows/sphinx_build.yml b/.github/workflows/sphinx_build.yml new file mode 100644 index 0000000..af7ab8d --- /dev/null +++ b/.github/workflows/sphinx_build.yml @@ -0,0 +1,21 @@ +name: "Build documentation" + +on: [push] + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v1 + # Standard drop-in approach that should work for most people. + - uses: ammaraskar/sphinx-action@master + with: + docs-folder: "docs/" + # Great extra actions to compose with: + # Create an artifact of the html output. + - uses: actions/upload-artifact@v1 + with: + name: DocumentationHTML + path: docs/_build/html/ From 6f176e7058cab0763051fa58eaf2c2c9e753d032 Mon Sep 17 00:00:00 2001 From: Lucy Liu Date: Wed, 4 Mar 2020 16:11:58 +0100 Subject: [PATCH 02/11] checkout vs --- .github/workflows/sphinx_build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/sphinx_build.yml b/.github/workflows/sphinx_build.yml index af7ab8d..f2332dd 100644 --- a/.github/workflows/sphinx_build.yml +++ b/.github/workflows/sphinx_build.yml @@ -8,7 +8,7 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v1 + - uses: actions/checkout@v2 # Standard drop-in approach that should work for most people. - uses: ammaraskar/sphinx-action@master with: From 27d0f66f8f7fe6474aae62b5f9e9018585e5e6cf Mon Sep 17 00:00:00 2001 From: Lucy Liu Date: Wed, 4 Mar 2020 16:13:57 +0100 Subject: [PATCH 03/11] update req --- doc/conf.py | 2 +- requirements.txt | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 3d8321c..4de82b2 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -20,7 +20,7 @@ # -- Project information ----------------------------------------------------- project = 'sample-project' -copyright = '2019, ' +copyright = '2020, ' author = '' # The full version, including alpha/beta/rc tags diff --git a/requirements.txt b/requirements.txt index 4b43f7e..c4ddebc 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1 +1,3 @@ -matplotlib \ No newline at end of file +sphinx +matplotlib +pandas \ No newline at end of file From 76cd89e9ba193301696576aa639bc2f42252689a Mon Sep 17 00:00:00 2001 From: Lucy Liu Date: Wed, 4 Mar 2020 16:16:28 +0100 Subject: [PATCH 04/11] rename docs --- {doc => docs}/Makefile | 0 {doc => docs}/class.rst | 0 {doc => docs}/conf.py | 0 {doc => docs}/function.rst | 0 {doc => docs}/getting_started.rst | 0 {doc => docs}/index.rst | 0 {doc => docs}/make.bat | 0 7 files changed, 0 insertions(+), 0 deletions(-) rename {doc => docs}/Makefile (100%) rename {doc => docs}/class.rst (100%) rename {doc => docs}/conf.py (100%) rename {doc => docs}/function.rst (100%) rename {doc => docs}/getting_started.rst (100%) rename {doc => docs}/index.rst (100%) rename {doc => docs}/make.bat (100%) diff --git a/doc/Makefile b/docs/Makefile similarity index 100% rename from doc/Makefile rename to docs/Makefile diff --git a/doc/class.rst b/docs/class.rst similarity index 100% rename from doc/class.rst rename to docs/class.rst diff --git a/doc/conf.py b/docs/conf.py similarity index 100% rename from doc/conf.py rename to docs/conf.py diff --git a/doc/function.rst b/docs/function.rst similarity index 100% rename from doc/function.rst rename to docs/function.rst diff --git a/doc/getting_started.rst b/docs/getting_started.rst similarity index 100% rename from doc/getting_started.rst rename to docs/getting_started.rst diff --git a/doc/index.rst b/docs/index.rst similarity index 100% rename from doc/index.rst rename to docs/index.rst diff --git a/doc/make.bat b/docs/make.bat similarity index 100% rename from doc/make.bat rename to docs/make.bat From 5437a97c1144e2fd26d4765d9d5f54dcfcbff862 Mon Sep 17 00:00:00 2001 From: Lucy Liu Date: Wed, 4 Mar 2020 16:24:46 +0100 Subject: [PATCH 05/11] update req --- requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/requirements.txt b/requirements.txt index c4ddebc..d1e688a 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,4 @@ sphinx +sphinx-gallery matplotlib pandas \ No newline at end of file From 6ea88538a19e626896791a00c006a58a5fee29a7 Mon Sep 17 00:00:00 2001 From: Lucy Liu Date: Wed, 4 Mar 2020 16:35:45 +0100 Subject: [PATCH 06/11] rename docs --- .circleci/config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 292235f..13d91c0 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -13,7 +13,7 @@ jobs: pip install -r requirements.txt --progress-bar off pip install sphinx sphinx-gallery sphinx_rtd_theme pandas matplotlib --progress-bar off pip install . - cd doc + cd docs make html - store_artifacts: path: doc/_build/html From 806b9f6f87d1213dc783dc9d91d66ca49bbb5729 Mon Sep 17 00:00:00 2001 From: Lucy Liu Date: Wed, 4 Mar 2020 16:42:27 +0100 Subject: [PATCH 07/11] pre build command --- .github/workflows/sphinx_build.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/sphinx_build.yml b/.github/workflows/sphinx_build.yml index f2332dd..ab49b4a 100644 --- a/.github/workflows/sphinx_build.yml +++ b/.github/workflows/sphinx_build.yml @@ -13,6 +13,7 @@ jobs: - uses: ammaraskar/sphinx-action@master with: docs-folder: "docs/" + pre-build-command: "pip install ." # Great extra actions to compose with: # Create an artifact of the html output. - uses: actions/upload-artifact@v1 From ae9dff59285f07874ca5a74b47210f41c909719c Mon Sep 17 00:00:00 2001 From: Lucy Liu Date: Wed, 4 Mar 2020 16:49:06 +0100 Subject: [PATCH 08/11] install req --- .github/workflows/sphinx_build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/sphinx_build.yml b/.github/workflows/sphinx_build.yml index ab49b4a..5383d4c 100644 --- a/.github/workflows/sphinx_build.yml +++ b/.github/workflows/sphinx_build.yml @@ -13,7 +13,7 @@ jobs: - uses: ammaraskar/sphinx-action@master with: docs-folder: "docs/" - pre-build-command: "pip install ." + pre-build-command: "pip install -r requirements.txt && pip install ." # Great extra actions to compose with: # Create an artifact of the html output. - uses: actions/upload-artifact@v1 From 75a7d7fec2cf358b4d1834fcb923f0397432bf00 Mon Sep 17 00:00:00 2001 From: Lucy Liu Date: Wed, 4 Mar 2020 16:54:46 +0100 Subject: [PATCH 09/11] add rtd theme --- requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/requirements.txt b/requirements.txt index d1e688a..f77958e 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,5 @@ sphinx sphinx-gallery +sphinx_rtd_theme matplotlib pandas \ No newline at end of file From 6b0d7508c1bb99e5a918119ae22596d039ad3a42 Mon Sep 17 00:00:00 2001 From: Lucy Liu Date: Wed, 4 Mar 2020 16:57:34 +0100 Subject: [PATCH 10/11] rename req file --- requirements.txt => requirements_doc.txt | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename requirements.txt => requirements_doc.txt (100%) diff --git a/requirements.txt b/requirements_doc.txt similarity index 100% rename from requirements.txt rename to requirements_doc.txt From 92b8382127c5ad0e1eab233288e4d6081f6db19e Mon Sep 17 00:00:00 2001 From: Lucy Liu Date: Wed, 4 Mar 2020 16:58:22 +0100 Subject: [PATCH 11/11] use new req --- .circleci/config.yml | 3 +-- .github/workflows/sphinx_build.yml | 2 +- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 13d91c0..01266cb 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -10,8 +10,7 @@ jobs: command: | python3 -m venv doc-env . doc-env/bin/activate - pip install -r requirements.txt --progress-bar off - pip install sphinx sphinx-gallery sphinx_rtd_theme pandas matplotlib --progress-bar off + pip install -r requirements_doc.txt --progress-bar off pip install . cd docs make html diff --git a/.github/workflows/sphinx_build.yml b/.github/workflows/sphinx_build.yml index 5383d4c..8a26887 100644 --- a/.github/workflows/sphinx_build.yml +++ b/.github/workflows/sphinx_build.yml @@ -13,7 +13,7 @@ jobs: - uses: ammaraskar/sphinx-action@master with: docs-folder: "docs/" - pre-build-command: "pip install -r requirements.txt && pip install ." + pre-build-command: "pip install -r requirements_doc.txt && pip install ." # Great extra actions to compose with: # Create an artifact of the html output. - uses: actions/upload-artifact@v1