docs: remove source — migrated to unilabsim/UniLab#1
Merged
Conversation
Documentation source has been migrated to the main UniLab repository at docs/sphinx/. This repo now serves only as the GitHub Pages deploy target (gh-pages branch receives built HTML from UniLab CI). Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
There was a problem hiding this comment.
Pull request overview
This PR turns this repository into a GitHub Pages deploy target only by removing the Sphinx documentation source tree and related build/deploy plumbing, and updating the README to point contributors to the new docs source location in unilabsim/UniLab.
Changes:
- Remove all Sphinx documentation source files under
source/(user guide, transfer tutorials, developer guide, API reference, templates, static assets). - Remove local/CI doc build tooling (
Makefile,requirements.txt,.github/workflows/docs.yml, and related Sphinx config). - Update
README.mdto explain the new workflow (docs authored inunilabsim/UniLab, HTML deployed to this repo’sgh-pagesbranch).
Reviewed changes
Copilot reviewed 109 out of 112 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| source/user_guide/tooling/wandb_and_tensorboard.md | Removed doc source (migrated to main UniLab repo). |
| source/user_guide/tooling/scene_export.md | Removed doc source (migrated to main UniLab repo). |
| source/user_guide/tooling/onnx_export.md | Removed doc source (migrated to main UniLab repo). |
| source/user_guide/tooling/nan_visualizer.md | Removed doc source (migrated to main UniLab repo). |
| source/user_guide/terrain/procedural.md | Removed doc source (migrated to main UniLab repo). |
| source/user_guide/terrain/heightfield_import.md | Removed doc source (migrated to main UniLab repo). |
| source/user_guide/tasks/manipulation_zoo.md | Removed doc source (migrated to main UniLab repo). |
| source/user_guide/tasks/locomotion_zoo.md | Removed doc source (migrated to main UniLab repo). |
| source/user_guide/tasks/go2_arm_manip_loco.md | Removed doc source (migrated to main UniLab repo). |
| source/user_guide/tasks/g1_motion_tracking.md | Removed doc source (migrated to main UniLab repo). |
| source/user_guide/manipulation/manip_loco.md | Removed doc source (migrated to main UniLab repo). |
| source/user_guide/manipulation/dexterous_inhand.md | Removed doc source (migrated to main UniLab repo). |
| source/user_guide/index.md | Removed doc source (migrated to main UniLab repo). |
| source/user_guide/getting_started/training.md | Removed doc source (migrated to main UniLab repo). |
| source/user_guide/getting_started/quickstart.md | Removed doc source (migrated to main UniLab repo). |
| source/user_guide/getting_started/installation.md | Removed doc source (migrated to main UniLab repo). |
| source/user_guide/getting_started/evaluation_and_playback.md | Removed doc source (migrated to main UniLab repo). |
| source/user_guide/getting_started/configuration_overrides.md | Removed doc source (migrated to main UniLab repo). |
| source/user_guide/domain_randomization/recipes.md | Removed doc source (migrated to main UniLab repo). |
| source/user_guide/backends/mujoco.md | Removed doc source (migrated to main UniLab repo). |
| source/user_guide/backends/motrix.md | Removed doc source (migrated to main UniLab repo). |
| source/user_guide/backends/index.md | Removed doc source (migrated to main UniLab repo). |
| source/user_guide/backends/choosing_a_backend.md | Removed doc source (migrated to main UniLab repo). |
| source/user_guide/algorithms/ppo.md | Removed doc source (migrated to main UniLab repo). |
| source/user_guide/algorithms/overview.md | Removed doc source (migrated to main UniLab repo). |
| source/user_guide/algorithms/mlx_ppo.md | Removed doc source (migrated to main UniLab repo). |
| source/user_guide/algorithms/hora.md | Removed doc source (migrated to main UniLab repo). |
| source/user_guide/algorithms/him_ppo.md | Removed doc source (migrated to main UniLab repo). |
| source/user_guide/algorithms/flash_sac.md | Removed doc source (migrated to main UniLab repo). |
| source/user_guide/algorithms/fast_td3.md | Removed doc source (migrated to main UniLab repo). |
| source/user_guide/algorithms/fast_sac.md | Removed doc source (migrated to main UniLab repo). |
| source/user_guide/algorithms/appo.md | Removed doc source (migrated to main UniLab repo). |
| source/transfer/sim_to_sim/why_switch.md | Removed doc source (migrated to main UniLab repo). |
| source/transfer/sim_to_sim/reward_parity_checks.md | Removed doc source (migrated to main UniLab repo). |
| source/transfer/sim_to_sim/playback_and_snapshot_differences.md | Removed doc source (migrated to main UniLab repo). |
| source/transfer/sim_to_sim/owner_yaml_swap.md | Removed doc source (migrated to main UniLab repo). |
| source/transfer/sim_to_sim/known_capability_gaps.md | Removed doc source (migrated to main UniLab repo). |
| source/transfer/sim_to_sim/contact_and_friction_alignment.md | Removed doc source (migrated to main UniLab repo). |
| source/transfer/sim_to_real/troubleshooting.md | Removed doc source (migrated to main UniLab repo). |
| source/transfer/sim_to_real/safety_layers.md | Removed doc source (migrated to main UniLab repo). |
| source/transfer/sim_to_real/overview.md | Removed doc source (migrated to main UniLab repo). |
| source/transfer/sim_to_real/onnx_export_and_runtime.md | Removed doc source (migrated to main UniLab repo). |
| source/transfer/sim_to_real/latency_and_observation_lag.md | Removed doc source (migrated to main UniLab repo). |
| source/transfer/sim_to_real/go2_locomotion.md | Removed doc source (migrated to main UniLab repo). |
| source/transfer/sim_to_real/g1_whole_body.md | Removed doc source (migrated to main UniLab repo). |
| source/transfer/sim_to_real/domain_randomization_for_real.md | Removed doc source (migrated to main UniLab repo). |
| source/transfer/sim_to_real/allegro_inhand.md | Removed doc source (migrated to main UniLab repo). |
| source/transfer/index.md | Removed doc source (migrated to main UniLab repo). |
| source/transfer/framework_migration/task_config_translation.md | Removed doc source (migrated to main UniLab repo). |
| source/transfer/framework_migration/reward_porting_cookbook.md | Removed doc source (migrated to main UniLab repo). |
| source/transfer/framework_migration/from_skrl.md | Removed doc source (migrated to main UniLab repo). |
| source/transfer/framework_migration/from_rsl_rl.md | Removed doc source (migrated to main UniLab repo). |
| source/transfer/framework_migration/from_legged_gym.md | Removed doc source (migrated to main UniLab repo). |
| source/transfer/framework_migration/from_isaac_lab.md | Removed doc source (migrated to main UniLab repo). |
| source/index.md | Removed doc source (migrated to main UniLab repo). |
| source/glossary.md | Removed doc source (migrated to main UniLab repo). |
| source/developer_guide/index.md | Removed doc source (migrated to main UniLab repo). |
| source/developer_guide/extending/new_terrain.md | Removed doc source (migrated to main UniLab repo). |
| source/developer_guide/extending/new_task.md | Removed doc source (migrated to main UniLab repo). |
| source/developer_guide/extending/new_backend.md | Removed doc source (migrated to main UniLab repo). |
| source/developer_guide/extending/new_algorithm.md | Removed doc source (migrated to main UniLab repo). |
| source/developer_guide/contributing.md | Removed doc source (migrated to main UniLab repo). |
| source/developer_guide/contributing_workflow.md | Removed doc source (migrated to main UniLab repo). |
| source/developer_guide/contracts/task_owner_config.md | Removed doc source (migrated to main UniLab repo). |
| source/developer_guide/contracts/runner_lifecycle.md | Removed doc source (migrated to main UniLab repo). |
| source/developer_guide/contracts/env_contract.md | Removed doc source (migrated to main UniLab repo). |
| source/developer_guide/contracts/domain_randomization.md | Removed doc source (migrated to main UniLab repo). |
| source/developer_guide/contracts/backend_capability.md | Removed doc source (migrated to main UniLab repo). |
| source/developer_guide/architecture/scene_composition.md | Removed doc source (migrated to main UniLab repo). |
| source/developer_guide/architecture/runtime_model.md | Removed doc source (migrated to main UniLab repo). |
| source/developer_guide/architecture/registry_bootstrap.md | Removed doc source (migrated to main UniLab repo). |
| source/developer_guide/architecture/layer_boundaries.md | Removed doc source (migrated to main UniLab repo). |
| source/developer_guide/architecture/development_standard.md | Removed doc source (migrated to main UniLab repo). |
| source/developer_guide/adr/README.md | Removed doc source (migrated to main UniLab repo). |
| source/developer_guide/adr/ADR-TEMPLATE.md | Removed doc source (migrated to main UniLab repo). |
| source/developer_guide/adr/ADR-0005-unified-obs-critic-env-and-ipc-contract.md | Removed doc source (migrated to main UniLab repo). |
| source/developer_guide/adr/ADR-0004-registry-bootstrap-contract.md | Removed doc source (migrated to main UniLab repo). |
| source/developer_guide/adr/ADR-0003-task-owner-and-config-compose-contract.md | Removed doc source (migrated to main UniLab repo). |
| source/developer_guide/adr/ADR-0002-backend-capability-boundary-for-play-and-snapshot.md | Removed doc source (migrated to main UniLab repo). |
| source/developer_guide/adr/ADR-0001-runtime-model-and-layer-boundaries.md | Removed doc source (migrated to main UniLab repo). |
| source/conf.py | Removed Sphinx configuration (build now happens in main UniLab repo). |
| source/changelog.md | Removed doc source (migrated to main UniLab repo). |
| source/api_reference/visualization/index.md | Removed API reference source (migrated to main UniLab repo). |
| source/api_reference/utils/index.md | Removed API reference source (migrated to main UniLab repo). |
| source/api_reference/training/index.md | Removed API reference source (migrated to main UniLab repo). |
| source/api_reference/top_level.md | Removed API reference source (migrated to main UniLab repo). |
| source/api_reference/tools/index.md | Removed API reference source (migrated to main UniLab repo). |
| source/api_reference/terrains/index.md | Removed API reference source (migrated to main UniLab repo). |
| source/api_reference/logging/index.md | Removed API reference source (migrated to main UniLab repo). |
| source/api_reference/ipc/index.md | Removed API reference source (migrated to main UniLab repo). |
| source/api_reference/index.md | Removed API reference source (migrated to main UniLab repo). |
| source/api_reference/envs/motion_tracking.md | Removed API reference source (migrated to main UniLab repo). |
| source/api_reference/envs/manipulation.md | Removed API reference source (migrated to main UniLab repo). |
| source/api_reference/envs/locomotion.md | Removed API reference source (migrated to main UniLab repo). |
| source/api_reference/envs/index.md | Removed API reference source (migrated to main UniLab repo). |
| source/api_reference/envs/common.md | Removed API reference source (migrated to main UniLab repo). |
| source/api_reference/dr/index.md | Removed API reference source (migrated to main UniLab repo). |
| source/api_reference/base/index.md | Removed API reference source (migrated to main UniLab repo). |
| source/api_reference/backend/index.md | Removed API reference source (migrated to main UniLab repo). |
| source/api_reference/algos/torch.md | Removed API reference source (migrated to main UniLab repo). |
| source/api_reference/algos/mlx.md | Removed API reference source (migrated to main UniLab repo). |
| source/api_reference/algos/index.md | Removed API reference source (migrated to main UniLab repo). |
| source/_templates/autosummary/module.rst | Removed Sphinx autosummary template (no longer built here). |
| source/_templates/autosummary/class.rst | Removed Sphinx autosummary template (no longer built here). |
| source/_static/css/custom.css | Removed custom Sphinx CSS (no longer built here). |
| requirements.txt | Removed doc build dependencies (no longer built here). |
| README.md | Updated to document the new “deploy target only” workflow. |
| Makefile | Removed Sphinx build targets (no longer built here). |
| .gitignore | Removed ignore rules (repo no longer hosts doc sources/build artifacts on main). |
| .github/workflows/docs.yml | Removed docs build/deploy workflow (build now occurs in main UniLab repo). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+13
to
+14
| HTML to this repository's `gh-pages` branch via deploy key. This repo only | ||
| holds the built output — **do not edit content here**. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/sphinx/Context
See unilabsim/UniLab#509 for the migration PR that moves source into the main repo.
After that merges, UniLab CI will build Sphinx and push HTML to this repo's
gh-pagesbranch via deploy key.