GGitHub[docs] Improve API reference documentation (#65 )

084ed7d4创建于 6月4日历史提交

文件	最后提交记录	最后更新时间
developer_guide	a patch of the PR #55 [perf report] (#56) add a link of performance_report.md to mkdoc.md Signed-off-by: dpj135 <958208521@qq.com>	2 个月前
logo	[doc] Prettify doc themes and issue template (#40) # Old theme <img width="2420" height="1030" alt="image" src="https://github.com/user-attachments/assets/e473e78d-1e7e-44bc-b68d-c561d7b76cc1" /> # New theme <img width="2656" height="934" alt="image" src="https://github.com/user-attachments/assets/2cc66c75-1d90-4805-b96e-8a28f5df0381" /> <img width="2606" height="1090" alt="image" src="https://github.com/user-attachments/assets/ce88026c-7962-4b9e-a008-d9ccea54e150" /> --------- Signed-off-by: tianyi-huawei <getianyi1@huawei.com> Co-authored-by: tianyi-huawei <getianyi1@huawei.com>	3 个月前
stylesheets	Prettify doc typography and content width (#42) ## Summary Documentation theme improvements: ### Typography Adjustments - h1: 2.5rem → 1.75rem - h2: 1.75rem → 1.35rem - h3: 1.25rem → 1.1rem ### Content Width Increase - Remove max-width restriction on .md-content - Increase .md-grid max-width from 61rem to 90rem for wider reading area This makes the document hierarchy more balanced and provides a wider reading area. ### Before <img width="2882" height="1408" alt="image" src="https://github.com/user-attachments/assets/1ba64e50-3f63-4b05-8fb1-fd0777d400a2" /> ###After <img width="2934" height="1378" alt="image" src="https://github.com/user-attachments/assets/66661944-51a9-4f90-9b91-a02106d71e70" /> ## Related This is part of the ongoing documentation theme improvements. --------- Signed-off-by: tianyi-huawei <getianyi1@huawei.com> Co-authored-by: tianyi-huawei <getianyi1@huawei.com>	3 个月前
user_guide	[docs] Improve API reference documentation (#65) # Description - Standardized format for each API with clear sections: Description, Parameters, Returns, Raises, Notes, and Examples - Added complete code examples with proper imports and realistic usage patterns - Improved clarity on when and where each function should be called # Fix - #58 --------- Signed-off-by: Artimislyy <2249614312@qq.com>	1 个月前
README.md	[docs] Prettify expression and publish docs to github pages (#28) # Description 1. add mdformat-mkdocs to ensure html rendering 1. markdown newline indent is by default 3 spaces, but mkdocs require 4 spaces for correct html rendering. so I installed `mdformat-mkdocs` in `pre-commit` to automatically fix it 2. prettify english expression 3. automatically publish to github pages before <img width="2940" height="1604" alt="image" src="https://github.com/user-attachments/assets/82746208-4e9e-42c4-9be5-4113146a6a53" /> after <img width="2940" height="1604" alt="image" src="https://github.com/user-attachments/assets/b2c7feae-1f34-4ebf-8bb9-ff4554638c97" /> --------- Signed-off-by: tianyi-huawei <getianyi1@huawei.com> Co-authored-by: tianyi-huawei <getianyi1@huawei.com>	4 个月前
index.md	[doc] Prettify doc themes and issue template (#40) # Old theme <img width="2420" height="1030" alt="image" src="https://github.com/user-attachments/assets/e473e78d-1e7e-44bc-b68d-c561d7b76cc1" /> # New theme <img width="2656" height="934" alt="image" src="https://github.com/user-attachments/assets/2cc66c75-1d90-4805-b96e-8a28f5df0381" /> <img width="2606" height="1090" alt="image" src="https://github.com/user-attachments/assets/ce88026c-7962-4b9e-a008-d9ccea54e150" /> --------- Signed-off-by: tianyi-huawei <getianyi1@huawei.com> Co-authored-by: tianyi-huawei <getianyi1@huawei.com>	3 个月前
mkdocs.yml	a patch of the PR #55 [perf report] (#56) add a link of performance_report.md to mkdoc.md Signed-off-by: dpj135 <958208521@qq.com>	2 个月前
requirements-docs.txt	[docs] Prettify expression and publish docs to github pages (#28) # Description 1. add mdformat-mkdocs to ensure html rendering 1. markdown newline indent is by default 3 spaces, but mkdocs require 4 spaces for correct html rendering. so I installed `mdformat-mkdocs` in `pre-commit` to automatically fix it 2. prettify english expression 3. automatically publish to github pages before <img width="2940" height="1604" alt="image" src="https://github.com/user-attachments/assets/82746208-4e9e-42c4-9be5-4113146a6a53" /> after <img width="2940" height="1604" alt="image" src="https://github.com/user-attachments/assets/b2c7feae-1f34-4ebf-8bb9-ff4554638c97" /> --------- Signed-off-by: tianyi-huawei <getianyi1@huawei.com> Co-authored-by: tianyi-huawei <getianyi1@huawei.com>	4 个月前

Ray Ascend Plugin documents

Build the docs

# Install the dependencies
pip install -r docs/requirements-docs.txt

# Build the docs
# Generate deployable static websites and PDFs in the `site/` directory.
mkdocs build -f mkdocs.yml

# Open the docs with your browser
mkdocs serve -f mkdocs.yml

Launch your browser and open:

English version: https://127.0.0.1:8000