Skip to content

[fix] align verl, VeOmni and LLaMA-Factory navigation with generated doc layout #131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zheliuyu merged 2 commits into from
May 20, 2026
Merged

[fix] align verl, VeOmni and LLaMA-Factory navigation with generated doc layout #131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e311295
[fix] align verl and VeOmni navigation with generated doc layout
zheliuyu May 19, 2026
cf029d6
[fix] align LLaMA-Factory navigation with generated doc layout
zheliuyu May 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,12 +207,15 @@ def generate_api_doc():
'verl': {
'display_name': 'verl',
'sidebar_mapping': {
'quick_start': '🚀 快速入门',
'features': '📚 特性指南',
'profiling': '⚡ 调优指南',
'examples': '📊 应用与调优实践',
'faq': '🔆 故障排查(FAQ)',
'contribution_guide': '🔧 开源开发'
'get_start': '🚀 快速开始',
'feature_support': '📚 特性支持',
'dev_guide/model_dev': '🧬 模型开发',
'dev_guide/precision_analysis': '🎯 精度调试',
'dev_guide/performance': '⚡ 性能调优',
'model_support/examples': '📋 最佳实践',
'model_support': '📊 模型支持',
'faq': '🔆 常见问题',
'contribution_guide': '🔧 开源开发',
}
},
'vllm-ascend': {
Expand Down
6 changes: 3 additions & 3 deletions index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@
<div class="project-card">
<div class="card-top"><div class="card-icon" style="background-image: url('_static/images/LLaMA-Factory.png')"></div><h3 class="card-title">LLaMA-Factory</h3></div>
<p class="card-desc">Unified Efficient Fine-Tuning of 100+ LLMs & VLMs。</p>
<div class="card-footer"><a href="https://github.com/hiyouga/LLaMA-Factory">官方链接</a><span class="split">|</span><a href="sources/_generated/sources/LLaMA-Factory/source/advanced/npu_installation.html">安装指南</a><span class="split">|</span><a href="sources/_generated/sources/LLaMA-Factory/source/advanced/npu_training.html">快速上手</a></div>
<div class="card-footer"><a href="https://github.com/hiyouga/LLaMA-Factory">官方链接</a><span class="split">|</span><a href="sources/_generated/sources/LLaMA-Factory/source/multibackend/npu/npu_installation.html">安装指南</a><span class="split">|</span><a href="sources/_generated/sources/LLaMA-Factory/source/multibackend/npu/npu_training.html">快速上手</a></div>
</div>

<!-- ms-swift -->
Expand Down Expand Up @@ -207,14 +207,14 @@
<div class="project-card">
<div class="card-top"><div class="card-icon" style="background-image: url('_static/images/VeOmni.png')"></div><h3 class="card-title">VeOmni</h3></div>
<p class="card-desc">Scaling Any Modality Model Training with Model-Centric Distributed Recipe Zoo。</p>
<div class="card-footer"><a href="https://github.com/ByteDance-Seed/VeOmni">官方链接</a><span class="split">|</span><a href="sources/_generated/sources/VeOmni/get_started/installation/install_ascend.html">安装指南</a><span class="split">|</span><a href="sources/_generated/sources/VeOmni/hardware_support/get_started_npu.html">快速上手</a></div>
<div class="card-footer"><a href="https://github.com/ByteDance-Seed/VeOmni">官方链接</a><span class="split">|</span><a href="sources/_generated/sources/VeOmni/get_started/installation/install_ascend_x86.html">安装指南</a><span class="split">|</span><a href="sources/_generated/sources/VeOmni/hardware_support/get_started_npu.html">快速上手</a></div>
</div>

<!-- verl -->
<div class="project-card">
<div class="card-top"><div class="card-icon" style="background-image: url('_static/images/volcano.png')"></div><h3 class="card-title">verl</h3></div>
<p class="card-desc">用于 LLM 的强化学习训练库，适配昇腾并行计算方案。</p>
<div class="card-footer"><a href="https://github.com/volcengine/verl">官方链接</a><span class="split">|</span><a href="sources/_generated/sources/verl/quick_start/ascend_quick_start.html">安装指南</a><span class="split">|</span><a href="sources/_generated/sources/verl/quick_start/ascend_quick_start.html">快速上手</a></div>
<div class="card-footer"><a href="https://github.com/volcengine/verl">官方链接</a><span class="split">|</span><a href="sources/_generated/sources/verl/get_start/install_guidance.html">安装指南</a><span class="split">|</span><a href="sources/_generated/sources/verl/get_start/quick_start.html">快速上手</a></div>
</div>

<!-- PyG -->
Expand Down
5 changes: 2 additions & 3 deletions sources/LLaMA-Factory/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,5 @@ LLaMA-Factory
.. toctree::
:maxdepth: 3

../_generated/sources/LLaMA-Factory/source/advanced/npu_installation
../_generated/sources/LLaMA-Factory/source/advanced/npu_training
../_generated/sources/LLaMA-Factory/source/advanced/distributed
../_generated/sources/LLaMA-Factory/source/multibackend/npu/npu_installation
../_generated/sources/LLaMA-Factory/source/multibackend/npu/npu_training
3 changes: 2 additions & 1 deletion sources/VeOmni/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@ VeOmni
.. toctree::
:maxdepth: 3

../_generated/sources/VeOmni/get_started/installation/install_ascend
../_generated/sources/VeOmni/get_started/installation/install_ascend_arm
../_generated/sources/VeOmni/get_started/installation/install_ascend_x86
../_generated/sources/VeOmni/hardware_support/get_started_npu
95 changes: 59 additions & 36 deletions sources/verl/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@ verl
/* 样式隔离：仅作用于首页入口 */
#verl-portal {
--v-primary: #0066cc;
--v-secondary: #00a86b;
--v-accent: #ff6b35;
--v-purple: #9d4edd;
--v-text-main: #1a1a1a;
--v-text-sub: #666666;
--v-border: #e1e4e8;
Expand All @@ -35,7 +32,6 @@ verl
font-weight: 600; transition: all 0.3s ease; border: 2px solid white;
}
.verl-btn-primary { background: white; color: var(--v-primary) !important; }
.verl-btn-secondary { background: transparent; color: white !important; }
.verl-btn:hover { transform: translateY(-2px); box-shadow: 0 8px 16px rgba(0,0,0,0.2); }

/* 快速开始卡片 */
Expand Down Expand Up @@ -87,32 +83,32 @@ verl
<h1>🚀 verl</h1>
<p class="verl-hero-subtitle">灵活、高效的大语言模型强化学习训练框架</p>
<div class="verl-hero-buttons">
<a href="https://github.com/volcengine/verl" class="verl-btn verl-btn-primary">📖 GitHub 仓库</a>
<a href="https://github.com/volcengine/verl" class="verl-btn verl-btn-primary" target="_blank" rel="noopener noreferrer">📖 GitHub 仓库</a>
</div>
</div>

<!-- 快速开始 -->
<h2 class="verl-section-title">🚀 快速开始</h2>
<div class="verl-quick-grid">
<a href="../_generated/sources/verl/quick_start/ascend_quick_start.html" class="verl-quick-card">
<div class="verl-quick-card-icon">📚</div>
<h4>快速入门</h4>
<p>昇腾环境搭建与基础训练示例</p>
<a href="../_generated/sources/verl/get_start/install_guidance.html" class="verl-quick-card">
<div class="verl-quick-card-icon">📦</div>
<h4>安装指南</h4>
<p>昇腾 NPU 自定义环境安装</p>
</a>
<a href="../_generated/sources/verl/features/ascend_backend_features.html" class="verl-quick-card">
<div class="verl-quick-card-icon">🔧</div>
<h4>特性指南</h4>
<p>昇腾后端特性与一致性说明</p>
<a href="../_generated/sources/verl/get_start/quick_start.html" class="verl-quick-card">
<div class="verl-quick-card-icon">🚀</div>
<h4>快速上手</h4>
<p>环境搭建与基础训练示例</p>
</a>
<a href="../_generated/sources/verl/examples/ascend_performance_analysis_guide.html" class="verl-quick-card">
<div class="verl-quick-card-icon">⚙️</div>
<h4>应用实践</h4>
<p>性能分析与最佳实践案例</p>
<a href="../_generated/sources/verl/feature_support/ascend_backend_features.html" class="verl-quick-card">
<div class="verl-quick-card-icon">🔧</div>
<h4>特性支持</h4>
<p>昇腾后端特性与 NPU 能力说明</p>
</a>
<a href="../_generated/sources/verl/contribution_guide/ascend_ci_guide_zh.html" class="verl-quick-card">
<div class="verl-quick-card-icon">👨‍💻</div>
<h4>开源开发</h4>
<p>CI 流程与贡献指南</p>
<p>CI 流程与社区贡献指南</p>
</a>
</div>

Expand All @@ -130,47 +126,74 @@ verl

----

.. 以下 toctree 引用 make copy-docs 生成的 _generated 内容，目录分组与
.. sources/_generated/sources/verl/README.md 及 conf.py 中 sidebar_mapping 保持一致。

.. toctree::
:maxdepth: 2
:hidden:
:caption: 🚀 快速开始

../_generated/sources/verl/get_start/install_guidance
../_generated/sources/verl/get_start/quick_start
../_generated/sources/verl/get_start/dockerfile_build_guidance

.. toctree::
:maxdepth: 2
:hidden:
:caption: 📚 特性支持

../_generated/sources/verl/feature_support/ascend_backend_features
../_generated/sources/verl/feature_support/npu_advance_features

.. toctree::
:maxdepth: 2
:hidden:
:caption: 🧬 模型开发

../_generated/sources/verl/dev_guide/model_dev/transfer_to_npu_guide
../_generated/sources/verl/dev_guide/model_dev/parameter_and_metrics
../_generated/sources/verl/dev_guide/model_dev/evaluation

.. toctree::
:maxdepth: 2
:hidden:
:caption: 🚀 快速入门
:caption: 🎯 精度调试

../_generated/sources/verl/quick_start/ascend_quick_start
../_generated/sources/verl/quick_start/ascend_sglang_quick_start
../_generated/sources/verl/quick_start/dockerfile_build_guidance
../_generated/sources/verl/dev_guide/precision_analysis/precision_alignment_zh
../_generated/sources/verl/dev_guide/precision_analysis/precision_debugger_zh

.. toctree::
:maxdepth: 2
:hidden:
:caption: 📚 特性指南
:caption: ⚡ 性能调优

../_generated/sources/verl/features/ascend_backend_features
../_generated/sources/verl/features/ascend_consistency
../_generated/sources/verl/dev_guide/performance/ascend_performance_analysis_guide
../_generated/sources/verl/dev_guide/performance/perf_tuning_on_ascend
../_generated/sources/verl/dev_guide/performance/ascend_profiling_zh
../_generated/sources/verl/dev_guide/performance/ascend_profiling_en

.. toctree::
:maxdepth: 2
:hidden:
:caption: ⚡ 调优指南
:caption: 📊 模型支持

../_generated/sources/verl/profiling/ascend_profiling_zh
../_generated/sources/verl/profiling/ascend_profiling_en
../_generated/sources/verl/model_support/model_and_algorithm_support

.. toctree::
:maxdepth: 2
:hidden:
:caption: 📊 应用与调优践实
:caption: 📋 最佳实践

../_generated/sources/verl/examples/ascend_performance_analysis_guide
../_generated/sources/verl/examples/ascend_sglang_best_practices
../_generated/sources/verl/examples/dapo_multi_model_optimization_practice
../_generated/sources/verl/examples/ascend_retool_best_pratice
../_generated/sources/verl/examples/run_qwen3_32B_megatron_1k_256k_npu
../_generated/sources/verl/examples/gspo_optimization_practice
../_generated/sources/verl/model_support/examples/dapo_multi_model_optimization_practice
../_generated/sources/verl/model_support/examples/gspo_optimization_practice
../_generated/sources/verl/model_support/examples/ascend_retool_best_pratice
../_generated/sources/verl/model_support/examples/ascend_sglang_best_practices

.. toctree::
:maxdepth: 2
:hidden:
:caption: 🔆 故障排查(FAQ)
:caption: 🔆 常见问题

../_generated/sources/verl/faq/faq

Expand Down
Loading