andrey/rCore-Tutorial-v3
1
0
Fork 0
mirror of https://github.com/rcore-os/rCore-Tutorial-v3.git synced 2025-01-18 21:17:14 +04:00
Code Issues Projects Releases Wiki Activity

update CI for build-doc

Browse Source
This commit is contained in:
Yu Chen 2022-03-20 23:45:23 +08:00
parent a61d34e2b1
commit 91c29d0b70
3 changed files with 16 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
.github/workflows/build-doc.yml vendored
View File

@ -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
publish_dir: ./os/target/riscv64gc-unknown-none-elf/doc
destination_dir: ${{ github.ref_name }}

15
README.md
View File

@ -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.

31
public/index.html
View File

@ -1,31 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
       <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
       <title>rcore-tutorial v3</title>
</head>
<body>
<h1> The API docs for Ten rCore Tutorial OSes </h1>
<br>
<h1><a href="./ch1/os/index.html">1. LibOS API doc</a></h1>
<h1><a href="./ch2/os/index.html">2. BatchOS API doc</a></h1>
<h1><a href="./ch3-coop/os/index.html">3.1 MultiProgOS API doc</a></h1>
<h1><a href="./ch3/os/index.html">3.2 TimeSharingOS API doc</a></h1>
<h1><a href="./ch4/os/index.html">4. AddrSpaceOS API doc</a></h1>
<h1><a href="./ch5/os/index.html">5. ProcessOS API doc</a></h1>
<h1><a href="./ch6/os/index.html">6. FileSystemOS API doc</a></h1>
<h1><a href="./ch7/os/index.html">7. IPCOS API doc</a></h1>
<h1><a href="./ch8/os/index.html">8. SyncMutexOS API doc</a></h1>
<h1><a href="./ch9/os/index.html">9. DeviceOS API doc</a></h1>
<h1><a href="./main/os/index.html">10. main-branch OS API doc</a></h1>
</body>
</html>