From bbc7d6d7da025c46c68dbd1da7bbe2b6d86aacdb Mon Sep 17 00:00:00 2001 From: Akio Taniguchi Date: Wed, 16 Sep 2020 15:29:50 +0900 Subject: [PATCH 1/4] #46 Uprate gh-pages workflow --- .github/workflows/gh-pages.yml | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml index 7d40f33..66bd21e 100644 --- a/.github/workflows/gh-pages.yml +++ b/.github/workflows/gh-pages.yml @@ -8,6 +8,7 @@ on: jobs: job: + name: GitHub Pages runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 @@ -15,15 +16,17 @@ jobs: uses: actions/setup-python@v2 with: python-version: 3.7 - - name: Build docs + - name: Install dependencies run: | + sudo apt install pandoc pip install poetry poetry install - poetry run etc/builddocs + - name: Build docs + run: poetry run etc/builddocs - name: Deploy docs uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./docs/_build publish_branch: gh-pages - force_orphan: true \ No newline at end of file + force_orphan: true From fdb38651ef58944b3160a2e78f7f9615a558c0ff Mon Sep 17 00:00:00 2001 From: Akio Taniguchi Date: Wed, 16 Sep 2020 15:30:10 +0900 Subject: [PATCH 2/4] #46 Update script for building docs --- etc/builddocs | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/etc/builddocs b/etc/builddocs index 952eb49..f21270b 100755 --- a/etc/builddocs +++ b/etc/builddocs @@ -1,6 +1,14 @@ #!/bin/bash set -eu -sphinx-apidoc -f -o docs/_apidoc deshima_sensitivity -sphinx-build docs docs/_build -sphinx-build docs docs/_build \ No newline at end of file + +# convert README.md to readme.rst +pandoc --column 500 -f markdown -t rst -o docs/readme.rst README.md + + +# auto-generate package guide +sphinx-apidoc -efT -o docs/_apidoc deshima_sensitivity + + +# build website +sphinx-build -a docs docs/_build From f186e6ea106fbae4e635dda12c58c2fd20a1d4c9 Mon Sep 17 00:00:00 2001 From: Akio Taniguchi Date: Wed, 16 Sep 2020 15:30:35 +0900 Subject: [PATCH 3/4] #46 Update index.rst to use readme --- docs/index.rst | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 28be1d8..bf0be01 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,15 +1,7 @@ -Welcome to deshima-sensitivity's documentation! -=============================================== +.. include:: readme.rst .. toctree:: :hidden: Home - Package guide <_apidoc/modules> - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` + Package guide <_apidoc/deshima_sensitivity> From 149420a03511072e77429923ab16d1ab0dbab629 Mon Sep 17 00:00:00 2001 From: Akio Taniguchi Date: Wed, 16 Sep 2020 15:30:48 +0900 Subject: [PATCH 4/4] #46 Remove DESHIMA logo --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 81f544a..52610fd 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -![DESHIMA logo](http://deshima.ewi.tudelft.nl/image/deshima_logo.png) - # deshima-sensitivity [![PyPI](https://img.shields.io/pypi/v/deshima-sensitivity.svg?label=PyPI&style=flat-square)](https://pypi.org/pypi/deshima-sensitivity/)