Repository navigation
Docs: per-topic directories + sphinx_reredirects - #60
Merged
Merged
Conversation
Mirrors the transformations/gazebo/navigation (and cybersecurity/cpp/ sas/docker/cmake) layout for the remaining 24 flat pages, one directory per toctree caption: - setup/: installation, terminator, workspace_setup - packages/: create_packages, create_python_package, create_python_node_with_template, source_after_build, running_node - python_node/: create_python_node_from_scratch, python_node_explained - python_library/: create_python_library, using_python_library - interfaces/: interfaces, create_interface_package - messages/: publishers_and_subscribers, inspecting_topics - parameters_and_launch/: parameters_and_launch, launch_configurable_nodes, inspecting_parameters - services/: service_servers_and_clients, inspecting_services - actions/: actions, action_servers, action_clients index.rst, tools.rst, faq.rst and the two included snippets (the_canonical_build_command, the_topic_is_under_heavy_construction) stay at the source root -- the snippets are included from every depth and the ../the_... convention of the existing topic dirs applies. Relative paths (literalinclude/:download: ../.. -> ../../.., snippet includes -> ../, terminator images) and the cross-references from tools.rst and sas/index.rst were rewritten; :ref: labels are path-independent. A full local sphinx html build reproduces the exact pre-existing warning set (mermaid/mmdc-absent, upstream 404, title underlines) with no broken references.
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.
The reorganisation
The three newest sections already use one directory per toctree caption (
transformations/,gazebo/,navigation/, pluscybersecurity/ cpp/ sas/ docker/ cmake/). This brings the remaining 24 flat pages into the same shape:setup/installation,terminator,workspace_setuppackages/create_packages,create_python_package,create_python_node_with_template,source_after_build,running_nodepython_node/create_python_node_from_scratch,python_node_explainedpython_library/create_python_library,using_python_libraryinterfaces/interfaces,create_interface_packagemessages/publishers_and_subscribers,inspecting_topicsparameters_and_launch/parameters_and_launch,launch_configurable_nodes,inspecting_parametersservices/service_servers_and_clients,inspecting_servicesactions/actions,action_servers,action_clientsindex.rst,tools.rst,faq.rstand the twoincluded snippets (the_canonical_build_command,the_topic_is_under_heavy_construction) stay at the source root — the snippets are included from every depth and../the_...from one dir down is already the established pattern.All moves are
git mv(history preserved). Path rewrites:literalinclude/:download:, snippetinclude::, terminator images, the root toctree and:doc:quick-start links, and the cross-refs intools.rst/sas/index.rst.:ref:labels are path-independent.Keeping the old URLs alive
sphinx_reredirects(1.1.0) hookshtml-collect-pages, so the meta-refresh stubs for all 24 old locations (.../en/latest/installation.htmletc.) are generated by the regular html build — no extra builder invocation or RTD job. (The 0.1.x-era-b redirectsrecipe would actually break the RTD build, since 1.1 dropped that builder.)Verification
sphinx-build -b htmllocally: build succeeded, warning set identical to before the move (mermaid/mmdc-absent locally, one upstream 404, pre-existing title/markup warnings) — no broken references, no orphan documentsinstallation.html->setup/installationsetup/installation.html,actions/action_clients.html)