Merge pull request #19 from whyjz/jb

Move from (Sphinx + Private hosting) to (Jupyter Book + Github pages)

Author: whyjz

.github/workflows/build.yml

@@ -0,0 +1,62 @@
+name: build-docs
+
+on:
+  # workflow_dispatch:
+  #   inputs:
+  #     logLevel:
+  #       description: 'Log level'
+  # Trigger the workflow on push to main & jb branch
+  push:
+    branches:
+    - jb
+    - main
+  pull_request:
+    branches:
+    - main
+
+jobs:
+  build-docs:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python 3.8 and conda/mamba
+      uses: conda-incubator/setup-miniconda@v2
+      with:
+        python-version: 3.8
+        mamba-version: "*"
+        channels: conda-forge
+        activate-environment: gmtjb
+        environment-file: environment_for-building-jb.yml
+        use-mamba: true
+    - name: Test environment
+      shell: bash -l {0}
+      run: |
+        conda info
+        conda list
+    - name: Build book
+      shell: bash -l {0}
+      run: |
+        bash generate_html.bash
+    - name: Deploy to gh-pages
+      # if: github.ref == 'refs/heads/main'
+      uses: peaceiris/actions-gh-pages@v3.8.0
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./docs/_build/html
+        
+        
+      # uses: s-weigand/setup-conda@v1
+      # with:
+      #   update-conda: true
+      #   conda-channels: conda-forge
+      #   python-version: 3.8
+    # - name: Install dependencies
+    #   run: |
+    #     python --version
+    #     conda env create -f environment_for-building-jb.yml
+    # - name: Build book
+    #   run: |
+    #     conda activate gmtjb
+    #     bash generate_html.bash

.gitignore

@@ -1,9 +1,4 @@
-_build/[dh]*
-_build/locale/.doctrees/*
-*~
-todolist.txt
+docs/_build
 *.mo
-.zanata-cache
-.zanata-cache/*
 .ipynb_checkpoints
-locales
+docs/conf.py

LICENSE.md

@@ -3,7 +3,7 @@ Commons Attribution 4.0 International (for other content) Licenses. Users can
 choose either or both licenses according to which part of the work they seek 
 permission.
 
-Copyright (c) 2016-2021 Whyjay Zheng. All rights reserved.
+Copyright (c) 2016-2022 Whyjay Zheng. All rights reserved.
 
 ## MIT License