rebuild metasim and roboverse seperate page on wiki

Author: geng-haoran

docs/source/_static/tea.jpg

@@ -0,0 +1,15 @@
+{# Override pydata_sphinx_theme's navbar-nav: render ONLY ``external_links``,
+   not the top-level toctree entries. We use the left sidebar (configured via
+   html_sidebars = {"**": ["globaltoc.html"]}) for in-site navigation, so the
+   top bar is reserved for the two cross-subsite links (MetaSim ↔ RoboVerse). #}
+<nav>
+  <ul class="bd-navbar-elements navbar-nav">
+    {%- for external_link in theme_external_links %}
+    <li class="nav-item">
+      <a class="nav-link nav-external" href="{{ external_link.url }}">
+        {{ external_link.name }}
+      </a>
+    </li>
+    {%- endfor %}
+  </ul>
+</nav>

docs/source/_templates/navbar-nav.html

@@ -0,0 +1,25 @@
+{# Renders the full captioned toctree in the left sidebar on EVERY page,
+   including the homepage. Equivalent to pydata's built-in
+   ``sidebar-nav-bs.html`` but with ``startdepth=0`` so the root page also
+   gets a populated sidebar (pydata's default suppresses the toctree on
+   the root page because ``_get_ancestor_pagename`` returns None there).
+
+   We deliberately use a different filename so that layout.html's
+   ``sidebars | reject('in', 'sidebar-nav-bs.html')`` rule does not strip
+   this template out on pages it considers ancestor-less. #}
+<nav class="bd-docs-nav bd-links"
+     aria-label="{{ _('Section Navigation') }}">
+  <p class="bd-links__title" role="heading" aria-level="1">{{ _("Section Navigation") }}</p>
+  <div class="bd-toc-item navbar-nav">
+    {{- generate_toctree_html(
+      "sidebar",
+      startdepth=0,
+      show_nav_level=theme_show_nav_level | int,
+      maxdepth=theme_navigation_depth | int,
+      collapse=theme_collapse_navigation | tobool,
+      includehidden=True,
+      titles_only=True
+      )
+    -}}
+  </div>
+</nav>

docs/source/_templates/sidebar-section-nav.html

@@ -1,5 +1,4 @@
 import os
-import re
 import subprocess
 import sys
 
@@ -76,7 +75,15 @@
     "logo": {
         "image_dark": "_static/RoboVerse86.22.svg",
     },
+    # Top navbar shows only the two cross-subsite links (MetaSim ↔ RoboVerse)
+    # via ``external_links`` (rendered through our overridden navbar-nav
+    # template). All in-site navigation lives in the left sidebar.
     "navbar_center": ["version-switcher", "navbar-nav"],
+    "external_links": [
+        {"name": "MetaSim", "url": "/metasim/"},
+        {"name": "RoboVerse", "url": "/roboverse/"},
+        {"name": "FAQ", "url": "/FAQ/"},
+    ],
     "show_version_warning_banner": False,
     "switcher": {
         "json_url": json_url,
@@ -100,6 +107,15 @@
 html_show_sphinx = False
 html_static_path = ["_static"]
 
+# Homepage shows only the body content (hero-style intro, no left rail);
+# every other page renders our custom sidebar-section-nav template, which
+# shows the captioned global toctree with ``startdepth=0 + includehidden=True``
+# so even root-of-section pages get a populated sidebar.
+html_sidebars = {
+    "index": [],
+    "**": ["sidebar-section-nav.html"],
+}
+
 ### Autodoc configurations ###
 autoclass_content = "class"
 autodoc_typehints = "signature"
@@ -229,85 +245,6 @@ def generate_task_markdown(app):
     )
 
 
-_NAVBAR_LABELS = {
-    "dataset_benchmark": {"short": "Dataset", "full": "Dataset and Benchmark"},
-    "roboverse_learn": {"short": "Learn", "full": "RoboVerse Learn"},
-    "FAQ": {"short": "FAQ", "full": "Frequently Asked Questions"},
-}
-
-
-def _active_navbar_section(pagename):
-    section = pagename.split("/", 1)[0]
-    return section if section in _NAVBAR_LABELS else None
-
-
-def _navbar_section_from_href(href, active_section):
-    if href == "#":
-        return active_section
-    for section in _NAVBAR_LABELS:
-        if href.endswith(f"{section}/index.html"):
-            return section
-    return None
-
-
-def _replace_navbar_item_label(match, active_section):
-    item_html = match.group(0)
-    href_match = re.search(r'href="([^"]+)"', item_html)
-    if href_match is None:
-        return item_html
-
-    section = _navbar_section_from_href(href_match.group(1), active_section)
-    if section is None:
-        return item_html
-
-    label_kind = "full" if section == active_section else "short"
-    label = _NAVBAR_LABELS[section][label_kind]
-    return re.sub(r"(>)[^<>]+(</a>)", rf"\1{label}\2", item_html, count=1)
-
-
-def _rewrite_navbar_labels(html, pagename):
-    active_section = _active_navbar_section(pagename)
-
-    def rewrite_navbar(match):
-        navbar_html = match.group(0)
-        return re.sub(
-            r'<li class="nav-item[^"]*">.*?</li>',
-            lambda item_match: _replace_navbar_item_label(item_match, active_section),
-            navbar_html,
-            flags=re.DOTALL,
-        )
-
-    return re.sub(
-        r'<ul class="bd-navbar-elements navbar-nav">.*?</ul>',
-        rewrite_navbar,
-        html,
-        flags=re.DOTALL,
-    )
-
-
-def normalize_navbar_labels(app, exception):
-    if exception is not None or app.builder.name != "html":
-        return
-
-    outdir = os.path.abspath(app.outdir)
-    for section in ("", *[f"{section}/" for section in _NAVBAR_LABELS]):
-        html_path = os.path.join(outdir, section, "index.html")
-        if not os.path.exists(html_path):
-            continue
-
-        pagename = "index" if section == "" else f"{section.rstrip('/')}/index"
-        with open(html_path, encoding="utf-8") as f:
-            html = f.read()
-
-        rewritten = _rewrite_navbar_labels(html, pagename)
-        if rewritten == html:
-            continue
-
-        with open(html_path, "w", encoding="utf-8") as f:
-            f.write(rewritten)
-
-
 def setup(app):
     app.connect("autodoc-skip-member", skip_member)
     app.connect("builder-inited", generate_task_markdown)
-    app.connect("build-finished", normalize_navbar_labels)

docs/source/conf.py

@@ -1,6 +1,6 @@
-# RoboVerse Documentation
+# RoboVerse
 
-![RoboVerse](./_static/Robo.png)
+![RoboVerse](./_static/tea.jpg)
 
 <p align="center">
   <a href="https://roboverseorg.github.io"><img src="https://img.shields.io/badge/project-page-brightgreen" alt="Project Page"></a>
@@ -136,10 +136,58 @@ If you find this work useful in your research, please consider citing:
 ```
 
 ```{toctree}
+:caption: Dataset & Benchmark
+:maxdepth: 2
+:titlesonly:
+:hidden:
+
+Overview <dataset_benchmark/index>
+Tasks Overview <dataset_benchmark/tasks/overview>
+Task Descriptions <dataset_benchmark/tasks/descriptions>
+Task Groups <dataset_benchmark/tasks/task_groups>
+Robots <dataset_benchmark/dataset/robots>
+Objects <dataset_benchmark/dataset/objects>
+Scenes <dataset_benchmark/dataset/scenes>
+Benchmark Overview <dataset_benchmark/benchmark/overview>
+Benchmark Results <dataset_benchmark/benchmark/results>
+Benchmark Usage <dataset_benchmark/benchmark/usage>
+```
+
+```{toctree}
+:caption: Imitation Learning
+:maxdepth: 2
+:titlesonly:
+:hidden:
+
+Overview <roboverse_learn/index>
+Diffusion Policy <roboverse_learn/imitation_learning/diffusion_policy>
+ACT <roboverse_learn/imitation_learning/ACT>
+OpenVLA <roboverse_learn/imitation_learning/openvla>
+SmolVLA <roboverse_learn/imitation_learning/smolvla>
+RDT <roboverse_learn/imitation_learning/rdt>
+Octo <roboverse_learn/imitation_learning/octo>
+Contributing <roboverse_learn/imitation_learning/contributing>
+```
+
+```{toctree}
+:caption: Reinforcement Learning
+:maxdepth: 2
+:titlesonly:
 :hidden:
+
+PPO <roboverse_learn/reinforcement_learning/ppo>
+FastTD3 <roboverse_learn/reinforcement_learning/fast_td3>
+SAC <roboverse_learn/reinforcement_learning/sac>
+TD3 <roboverse_learn/reinforcement_learning/td3>
+SkillBlender <roboverse_learn/reinforcement_learning/skillblender_rl>
+Humanoid <roboverse_learn/reinforcement_learning/humanoid>
+```
+
+```{toctree}
+:caption: FAQ
+:maxdepth: 2
 :titlesonly:
+:hidden:
 
-Dataset <dataset_benchmark/index>
-Learn <roboverse_learn/index>
-FAQ <FAQ/index>
+FAQ/index
 ```

docs/source/index.md

@@ -0,0 +1,61 @@
+---
+orphan: true
+---
+
+# RoboVerse
+
+**RoboVerse** is the dataset, benchmark, task-pack, and learning layer that sits on
+top of the [MetaSim](https://roboverse.wiki/metasim/) simulator framework. This
+section brings together the task inventory, asset descriptions, benchmark protocol,
+and the imitation- and reinforcement-learning workflows.
+
+---
+
+## Quick Navigation
+
+::::{grid} 2
+:gutter: 3
+
+:::{grid-item-card} Tasks Overview
+:link: /dataset_benchmark/tasks/overview
+:link-type: doc
+
+Browse the full task inventory across every benchmark namespace.
+:::
+
+:::{grid-item-card} Robots, Objects, Scenes
+:link: /dataset_benchmark/dataset/robots
+:link-type: doc
+
+Robot configurations, object assets, and scene definitions used by tasks.
+:::
+
+:::{grid-item-card} Imitation Learning
+:link: /roboverse_learn/imitation_learning/diffusion_policy
+:link-type: doc
+
+Diffusion Policy, ACT, OpenVLA, SmolVLA, RDT, Octo and how to add your own.
+:::
+
+:::{grid-item-card} Reinforcement Learning
+:link: /roboverse_learn/reinforcement_learning/ppo
+:link-type: doc
+
+PPO, FastTD3, SAC, TD3, SkillBlender, humanoid locomotion stacks.
+:::
+
+:::{grid-item-card} Benchmark Protocol & Results
+:link: /dataset_benchmark/benchmark/overview
+:link-type: doc
+
+Standard evaluation protocols and the latest benchmark results.
+:::
+
+:::{grid-item-card} MetaSim docs ↗
+:link: /metasim/
+:link-type: url
+
+Simulator core: concepts, handlers, API reference, troubleshooting.
+:::
+
+::::

docs/source/roboverse/index.md

@@ -36,8 +36,10 @@ fi
 rm -rf "$output_dir"
 mkdir -p "$output_dir"
 
-cp -a "$repo_root/docs/landing/." "$output_dir/"
-"$python_bin" -m sphinx -b html "$repo_root/docs/source" "$output_dir/roboverse"
+# RoboVerse docs are the homepage — built directly at the site root so
+# visiting roboverse.wiki/ lands on the Sphinx RoboVerse intro, matching
+# the pre-#764 deployment layout. MetaSim docs live under /metasim/.
+"$python_bin" -m sphinx -b html "$repo_root/docs/source" "$output_dir"
 "$python_bin" -m sphinx -b html "$metasim_dir/docs/source" "$output_dir/metasim"
 
 if [[ -f "$metasim_dir/docs/source/images/tea.jpg" ]]; then