diff --git a/.github/workflows/build-doc.yml b/.github/workflows/build-doc.yml index 7de1beda..a48f1474 100644 --- a/.github/workflows/build-doc.yml +++ b/.github/workflows/build-doc.yml @@ -15,14 +15,11 @@ jobs: rustup target add riscv64gc-unknown-none-elf rustup component add llvm-tools-preview rustup component add rust-src - rm -rf public/${{ github.ref_name }} - mkdir -p public/${{ github.ref_name }} cd os cargo doc --no-deps --verbose - cp -r ./target/riscv64gc-unknown-none-elf/doc ../public/${{ github.ref_name }} - name: Deploy to Github Pages uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./public - destination_dir: ./docs \ No newline at end of file + publish_dir: ./os/target/riscv64gc-unknown-none-elf/doc + destination_dir: ${{ github.ref_name }} \ No newline at end of file diff --git a/README.md b/README.md index 00a94f1b..5f27d55e 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # rCore-Tutorial-v3 rCore-Tutorial version 3.5. See the [Documentation in Chinese](https://rcore-os.github.io/rCore-Tutorial-Book-v3/). -rCore-Tutorial API Docs. See the [API Docs of Ten OSes ](https://rcore-os.github.io/rCore-Tutorial-v3/index.html) +rCore-Tutorial API Docs. See the [API Docs of Ten OSes ](#OS-API-DOCS) Official QQ group number: 735045051 @@ -194,6 +194,19 @@ Currently it can only help you view the code since only a tiny part of the code You can open a doc html of `os` using `cargo doc --no-deps --open` under `os` directory. +### OS-API-DOCS +The API Docs for Ten OS +1. [Lib-OS API doc](https://learningos.github.io/rCore-Tutorial-v3/ch1/os/index.html) +1. [Batch-OS API doc](https://learningos.github.io/rCore-Tutorial-v3/ch2/os/index.html) +1. [MultiProg-OS API doc](https://learningos.github.io/rCore-Tutorial-v3/ch3-coop/os/index.html) +1. [TimeSharing-OS API doc](https://learningos.github.io/rCore-Tutorial-v3/ch3/os/index.html) +1. [AddrSpace-OS API doc](https://learningos.github.io/rCore-Tutorial-v3/ch4/os/index.html) +1. [Process-OS API doc](https://learningos.github.io/rCore-Tutorial-v3/ch5/os/index.html) +1. [FileSystem-OS API doc](https://learningos.github.io/rCore-Tutorial-v3/ch6/os/index.html) +1. [IPC-OS API doc](https://learningos.github.io/rCore-Tutorial-v3/ch7/os/index.html) +1. [SyncMutex-OS API doc](https://learningos.github.io/rCore-Tutorial-v3/ch8/os/index.html) +1. [IODevice-OS API doc](https://learningos.github.io/rCore-Tutorial-v3/ch9/os/index.html) + ## Working in progress Our first release 3.5.0 (chapter 1-7) has been published. diff --git a/public/index.html b/public/index.html deleted file mode 100644 index f64ce524..00000000 --- a/public/index.html +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - -
- - - -