diff --git a/.github/workflows/jupyterbook-publish.yml b/.github/workflows/jupyterbook-publish.yml new file mode 100644 index 0000000..5624ec2 --- /dev/null +++ b/.github/workflows/jupyterbook-publish.yml @@ -0,0 +1,43 @@ +name: jupyterbook-publish + +# Only run this when the master branch changes +on: + push: + branches: + - main + - master + # If your git repository has the Jupyter Book within some-subfolder next to + # unrelated files, you can make this run only if a file within that specific + # folder has been modified. + # + # paths: + # - some-subfolder/** + +# This job installs dependencies, builds the book, and pushes it to `gh-pages` +jobs: + deploy-book: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + + # Install dependencies + - name: Set up Python 3.9 + uses: actions/setup-python@v2 + with: + python-version: 3.9 + + - name: Install dependencies + run: | + pip install jupyter-book + + # Build the book + - name: Build the book + run: | + jupyter-book build . + + # Push the book's HTML to github-pages + - name: GitHub Pages action + uses: peaceiris/actions-gh-pages@v3.6.1 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./_build/html \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0f25098 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +_build/ +.vscode/ +.idea/ \ No newline at end of file diff --git a/1_example_chapter/1_example_section/1_example_article.md b/1_example_chapter/1_example_section/1_example_article.md new file mode 100644 index 0000000..9233c38 --- /dev/null +++ b/1_example_chapter/1_example_section/1_example_article.md @@ -0,0 +1,6 @@ +--- +level: introductory +stage: alpha +--- + +# 测试文章 diff --git a/1_example_chapter/1_example_section/1_example_article2.md b/1_example_chapter/1_example_section/1_example_article2.md new file mode 100644 index 0000000..db8928f --- /dev/null +++ b/1_example_chapter/1_example_section/1_example_article2.md @@ -0,0 +1,6 @@ +--- +level: introductory +stage: alpha +--- + +# 测试文章2 diff --git a/1_example_chapter/1_example_section/README.md b/1_example_chapter/1_example_section/README.md new file mode 100644 index 0000000..d3ed8ec --- /dev/null +++ b/1_example_chapter/1_example_section/README.md @@ -0,0 +1 @@ +# 示例节1 diff --git a/1_example_chapter/2_example_article3.md b/1_example_chapter/2_example_article3.md new file mode 100644 index 0000000..336f212 --- /dev/null +++ b/1_example_chapter/2_example_article3.md @@ -0,0 +1,6 @@ +--- +level: introductory +stage: alpha +--- + +# 测试文章3 diff --git a/1_example_chapter/README.md b/1_example_chapter/README.md new file mode 100644 index 0000000..d68340c --- /dev/null +++ b/1_example_chapter/README.md @@ -0,0 +1 @@ +# 示例章 \ No newline at end of file diff --git a/2_example_chapter2/1_example_section2/README.md b/2_example_chapter2/1_example_section2/README.md new file mode 100644 index 0000000..89a285f --- /dev/null +++ b/2_example_chapter2/1_example_section2/README.md @@ -0,0 +1 @@ +# 示例节2 diff --git a/2_example_chapter2/README.md b/2_example_chapter2/README.md new file mode 100644 index 0000000..1825e6a --- /dev/null +++ b/2_example_chapter2/README.md @@ -0,0 +1 @@ +# 示例章2 \ No newline at end of file diff --git a/3_example_chapter3/README.md b/3_example_chapter3/README.md new file mode 100644 index 0000000..1825e6a --- /dev/null +++ b/3_example_chapter3/README.md @@ -0,0 +1 @@ +# 示例章2 \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..c9db351 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,13 @@ +# CHANGELOG + +## [0.2.0] - 2023-12-15 + +增加发布流水线；修改部分配置。 + +## [0.1.1] - 2022-10-10 + +修复ToC异常。 + +## [0.1.0] - 2022-09-30 + +最小可用版本。 diff --git a/README.md b/README.md new file mode 100644 index 0000000..0ceb343 --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +# 量潮示例文档项目 diff --git a/_config.yml b/_config.yml new file mode 100644 index 0000000..a255055 --- /dev/null +++ b/_config.yml @@ -0,0 +1,7 @@ +# https://jupyterbook.org/en/stable/customize/config.html +name: quanttide-example-of-documentation +title: 量潮示例文档项目 +author: 量潮科技 +description: 量潮文档项目实例 +# Jupyter Book Config +only_build_toc_files: true \ No newline at end of file diff --git a/_toc.yml b/_toc.yml new file mode 100644 index 0000000..6d0c126 --- /dev/null +++ b/_toc.yml @@ -0,0 +1,18 @@ +format: jb-book +root: index.md +parts: + - caption: 示例部分 + chapters: + - file: 1_example_chapter/README.md + sections: + - file: 1_example_chapter/1_example_section/README.md + sections: + - file: 1_example_chapter/1_example_section/1_example_article.md + - file: 1_example_chapter/1_example_section/1_example_article2.md + - file: 1_example_chapter/2_example_article3.md + - caption: 示例部分2 + chapters: + - file: 2_example_chapter2/README.md + sections: + - file: 2_example_chapter2/1_example_section2/README.md + - file: 3_example_chapter3/README.md \ No newline at end of file diff --git a/index.md b/index.md new file mode 100644 index 0000000..b6d4af6 --- /dev/null +++ b/index.md @@ -0,0 +1 @@ +# 简介