Merged
Conversation
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.
Title: Docs: coherent index structure + Python Client API link + safer Sphinx builds
Fixes: #
About
This PR reorganizes the documentation navigation, fixes incorrect/obsolete paths, and makes the Sphinx builds more deterministic.
Highlights
Reworked
docs/index.mdinto a coherent, multi-section tree:transition_from_airsim.md,system_specs.md,faq.md,license.mddevelopment/use_source.md,development/use_prebuilt.md, etc.)api.mdandros/ros.mdclient_api/index.html(intended target of the Python client autodoc export)Removed/rewired stale references:
code_structure.mdsectiondevelopment/physics/unreal_physics.mdanddevelopment/scene/sim_clock_development.mdwith the existingdevelopment/scene/sim_clock_internal.mdCI improvement in
.github/workflows/sphinx-docs.yml:rm -rf build) beforemake htmlfor both the Python client docs and the main docs to avoid stale artifactsHow Has This Been Tested?
Local (Ubuntu 22.04):
make -C client/python/projectairsim/docs htmlto generate the Python client docsmake -C docs htmlto build the main siteCI (GitHub Actions):
Result: “Python Client API” menu item points to
client_api/index.html(when the client docs are exported/copied intodocs/build/html/client_api).Screenshots and videos (if appropriate):
.github/workflows/sphinx-docs.ymlanddocs/index.mdshowing the changes in structure and build steps.Follow-ups (separate PR or commit)
Wire the “Copy Python client docs into main docs” step to one of these:
docs/build/html/client_api(e.g.,sphinx-build -b html client/python/projectairsim/docs docs/build/html/client_api)docs/build/html/client_apiOptionally add a
linkcheckjob (sphinx-build -b linkcheck) to catch broken links automatically.