diff --git a/.circleci/config.yml b/.circleci/config.yml index ef36f3589f..8517b1ada4 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -20,16 +20,16 @@ references: make_docs: &make_docs run: command: | - cd nav2_docs/sphinx_doc + cd nav2_docs make html store_docs: &store_docs store_artifacts: - path: nav2_docs/sphinx_doc/_build/html + path: nav2_docs/_build/html destination: html publish_docs: &publish_docs run: command: | - cd nav2_docs/sphinx_doc + cd nav2_docs make publish install_deployment_key: &install_deployment_key add_ssh_keys: @@ -65,9 +65,9 @@ jobs: - *on_checkout - build_docs - persist_to_workspace: - root: nav2_docs + root: . paths: - - sphinx_doc + - nav2_docs docs_publish: executor: docs_exec steps: diff --git a/sphinx_doc/Makefile b/Makefile similarity index 100% rename from sphinx_doc/Makefile rename to Makefile diff --git a/sphinx_doc/_themes/otc_tcs_sphinx_theme/.gitignore b/_themes/otc_tcs_sphinx_theme/.gitignore similarity index 100% rename from sphinx_doc/_themes/otc_tcs_sphinx_theme/.gitignore rename to _themes/otc_tcs_sphinx_theme/.gitignore diff --git a/sphinx_doc/_themes/otc_tcs_sphinx_theme/layout.html b/_themes/otc_tcs_sphinx_theme/layout.html similarity index 100% rename from sphinx_doc/_themes/otc_tcs_sphinx_theme/layout.html rename to _themes/otc_tcs_sphinx_theme/layout.html diff --git a/sphinx_doc/_themes/otc_tcs_sphinx_theme/readme.rst b/_themes/otc_tcs_sphinx_theme/readme.rst similarity index 100% rename from sphinx_doc/_themes/otc_tcs_sphinx_theme/readme.rst rename to _themes/otc_tcs_sphinx_theme/readme.rst diff --git a/sphinx_doc/_themes/otc_tcs_sphinx_theme/static/tcs_theme.css b/_themes/otc_tcs_sphinx_theme/static/tcs_theme.css similarity index 100% rename from sphinx_doc/_themes/otc_tcs_sphinx_theme/static/tcs_theme.css rename to _themes/otc_tcs_sphinx_theme/static/tcs_theme.css diff --git a/sphinx_doc/_themes/otc_tcs_sphinx_theme/static/tcs_theme.js b/_themes/otc_tcs_sphinx_theme/static/tcs_theme.js similarity index 100% rename from sphinx_doc/_themes/otc_tcs_sphinx_theme/static/tcs_theme.js rename to _themes/otc_tcs_sphinx_theme/static/tcs_theme.js diff --git a/sphinx_doc/_themes/otc_tcs_sphinx_theme/theme.conf b/_themes/otc_tcs_sphinx_theme/theme.conf similarity index 100% rename from sphinx_doc/_themes/otc_tcs_sphinx_theme/theme.conf rename to _themes/otc_tcs_sphinx_theme/theme.conf diff --git a/sphinx_doc/about/images/coming_soon.jpeg b/about/images/coming_soon.jpeg similarity index 100% rename from sphinx_doc/about/images/coming_soon.jpeg rename to about/images/coming_soon.jpeg diff --git a/sphinx_doc/about/images/move_base_compare_2.png b/about/images/move_base_compare_2.png similarity index 100% rename from sphinx_doc/about/images/move_base_compare_2.png rename to about/images/move_base_compare_2.png diff --git a/sphinx_doc/about/images/rb1.png b/about/images/rb1.png similarity index 100% rename from sphinx_doc/about/images/rb1.png rename to about/images/rb1.png diff --git a/sphinx_doc/about/images/rover.png b/about/images/rover.png similarity index 100% rename from sphinx_doc/about/images/rover.png rename to about/images/rover.png diff --git a/sphinx_doc/about/images/tb2.png b/about/images/tb2.png similarity index 100% rename from sphinx_doc/about/images/tb2.png rename to about/images/tb2.png diff --git a/sphinx_doc/about/images/tb3.png b/about/images/tb3.png similarity index 100% rename from sphinx_doc/about/images/tb3.png rename to about/images/tb3.png diff --git a/sphinx_doc/about/images/tiago.png b/about/images/tiago.png similarity index 100% rename from sphinx_doc/about/images/tiago.png rename to about/images/tiago.png diff --git a/sphinx_doc/about/images/yunji.png b/about/images/yunji.png similarity index 100% rename from sphinx_doc/about/images/yunji.png rename to about/images/yunji.png diff --git a/sphinx_doc/about/index.rst b/about/index.rst similarity index 100% rename from sphinx_doc/about/index.rst rename to about/index.rst diff --git a/sphinx_doc/about/robots.rst b/about/robots.rst similarity index 100% rename from sphinx_doc/about/robots.rst rename to about/robots.rst diff --git a/sphinx_doc/about/ros1_comparison.rst b/about/ros1_comparison.rst similarity index 100% rename from sphinx_doc/about/ros1_comparison.rst rename to about/ros1_comparison.rst diff --git a/sphinx_doc/build_instructions/build_docs/build_troubleshooting_guide.rst b/build_instructions/build_docs/build_troubleshooting_guide.rst similarity index 100% rename from sphinx_doc/build_instructions/build_docs/build_troubleshooting_guide.rst rename to build_instructions/build_docs/build_troubleshooting_guide.rst diff --git a/sphinx_doc/build_instructions/index.rst b/build_instructions/index.rst similarity index 100% rename from sphinx_doc/build_instructions/index.rst rename to build_instructions/index.rst diff --git a/sphinx_doc/concepts/index.rst b/concepts/index.rst similarity index 100% rename from sphinx_doc/concepts/index.rst rename to concepts/index.rst diff --git a/sphinx_doc/conf.py b/conf.py similarity index 100% rename from sphinx_doc/conf.py rename to conf.py diff --git a/sphinx_doc/configuration/configuring-the-controller.rst b/configuration/configuring-the-controller.rst similarity index 100% rename from sphinx_doc/configuration/configuring-the-controller.rst rename to configuration/configuring-the-controller.rst diff --git a/sphinx_doc/configuration/dwb-plugins/goal-checkers.rst b/configuration/dwb-plugins/goal-checkers.rst similarity index 100% rename from sphinx_doc/configuration/dwb-plugins/goal-checkers.rst rename to configuration/dwb-plugins/goal-checkers.rst diff --git a/sphinx_doc/configuration/dwb-plugins/trajectory-critics.rst b/configuration/dwb-plugins/trajectory-critics.rst similarity index 100% rename from sphinx_doc/configuration/dwb-plugins/trajectory-critics.rst rename to configuration/dwb-plugins/trajectory-critics.rst diff --git a/sphinx_doc/configuration/dwb-plugins/trajectory-generators.rst b/configuration/dwb-plugins/trajectory-generators.rst similarity index 100% rename from sphinx_doc/configuration/dwb-plugins/trajectory-generators.rst rename to configuration/dwb-plugins/trajectory-generators.rst diff --git a/sphinx_doc/configuration/index.rst b/configuration/index.rst similarity index 100% rename from sphinx_doc/configuration/index.rst rename to configuration/index.rst diff --git a/sphinx_doc/configuration/params/tunable-params.rst b/configuration/params/tunable-params.rst similarity index 100% rename from sphinx_doc/configuration/params/tunable-params.rst rename to configuration/params/tunable-params.rst diff --git a/sphinx_doc/contribute/index.rst b/contribute/index.rst similarity index 100% rename from sphinx_doc/contribute/index.rst rename to contribute/index.rst diff --git a/sphinx_doc/getting_started/images/navigation_with_recovery_behaviours.gif b/getting_started/images/navigation_with_recovery_behaviours.gif similarity index 100% rename from sphinx_doc/getting_started/images/navigation_with_recovery_behaviours.gif rename to getting_started/images/navigation_with_recovery_behaviours.gif diff --git a/sphinx_doc/getting_started/index.rst b/getting_started/index.rst similarity index 100% rename from sphinx_doc/getting_started/index.rst rename to getting_started/index.rst diff --git a/sphinx_doc/images/architectural_diagram.png b/images/architectural_diagram.png similarity index 100% rename from sphinx_doc/images/architectural_diagram.png rename to images/architectural_diagram.png diff --git a/sphinx_doc/images/favicon-16x16.png b/images/favicon-16x16.png similarity index 100% rename from sphinx_doc/images/favicon-16x16.png rename to images/favicon-16x16.png diff --git a/sphinx_doc/images/favicon-48x48.png b/images/favicon-48x48.png similarity index 100% rename from sphinx_doc/images/favicon-48x48.png rename to images/favicon-48x48.png diff --git a/sphinx_doc/images/gazebo/gazebo_turtlebot1.png b/images/gazebo/gazebo_turtlebot1.png similarity index 100% rename from sphinx_doc/images/gazebo/gazebo_turtlebot1.png rename to images/gazebo/gazebo_turtlebot1.png diff --git a/sphinx_doc/images/logo_dark.png b/images/logo_dark.png similarity index 100% rename from sphinx_doc/images/logo_dark.png rename to images/logo_dark.png diff --git a/sphinx_doc/images/logo_dark_120w.png b/images/logo_dark_120w.png similarity index 100% rename from sphinx_doc/images/logo_dark_120w.png rename to images/logo_dark_120w.png diff --git a/sphinx_doc/images/logo_white.png b/images/logo_white.png similarity index 100% rename from sphinx_doc/images/logo_white.png rename to images/logo_white.png diff --git a/sphinx_doc/images/logo_white_200w.png b/images/logo_white_200w.png similarity index 100% rename from sphinx_doc/images/logo_white_200w.png rename to images/logo_white_200w.png diff --git a/sphinx_doc/images/rviz/navigate-to-pose.png b/images/rviz/navigate-to-pose.png similarity index 100% rename from sphinx_doc/images/rviz/navigate-to-pose.png rename to images/rviz/navigate-to-pose.png diff --git a/sphinx_doc/images/rviz/navigating.png b/images/rviz/navigating.png similarity index 100% rename from sphinx_doc/images/rviz/navigating.png rename to images/rviz/navigating.png diff --git a/sphinx_doc/images/rviz/navstack-ready.png b/images/rviz/navstack-ready.png similarity index 100% rename from sphinx_doc/images/rviz/navstack-ready.png rename to images/rviz/navstack-ready.png diff --git a/sphinx_doc/images/rviz/rviz-not-started.png b/images/rviz/rviz-not-started.png similarity index 100% rename from sphinx_doc/images/rviz/rviz-not-started.png rename to images/rviz/rviz-not-started.png diff --git a/sphinx_doc/images/rviz/rviz-set-initial-pose.png b/images/rviz/rviz-set-initial-pose.png similarity index 100% rename from sphinx_doc/images/rviz/rviz-set-initial-pose.png rename to images/rviz/rviz-set-initial-pose.png diff --git a/sphinx_doc/images/rviz/rviz_initial.png b/images/rviz/rviz_initial.png similarity index 100% rename from sphinx_doc/images/rviz/rviz_initial.png rename to images/rviz/rviz_initial.png diff --git a/sphinx_doc/index.rst b/index.rst similarity index 100% rename from sphinx_doc/index.rst rename to index.rst diff --git a/sphinx_doc/make.bat b/make.bat similarity index 100% rename from sphinx_doc/make.bat rename to make.bat diff --git a/sphinx_doc/migration/Dashing.rst b/migration/Dashing.rst similarity index 100% rename from sphinx_doc/migration/Dashing.rst rename to migration/Dashing.rst diff --git a/sphinx_doc/migration/Eloquent.rst b/migration/Eloquent.rst similarity index 100% rename from sphinx_doc/migration/Eloquent.rst rename to migration/Eloquent.rst diff --git a/sphinx_doc/migration/index.rst b/migration/index.rst similarity index 100% rename from sphinx_doc/migration/index.rst rename to migration/index.rst diff --git a/sphinx_doc/plugins/index.rst b/plugins/index.rst similarity index 100% rename from sphinx_doc/plugins/index.rst rename to plugins/index.rst diff --git a/sphinx_doc/scripts/.nojekyll b/scripts/.nojekyll similarity index 100% rename from sphinx_doc/scripts/.nojekyll rename to scripts/.nojekyll diff --git a/sphinx_doc/scripts/_nojekyll b/scripts/_nojekyll similarity index 100% rename from sphinx_doc/scripts/_nojekyll rename to scripts/_nojekyll diff --git a/sphinx_doc/scripts/docker/Dockerfile b/scripts/docker/Dockerfile similarity index 100% rename from sphinx_doc/scripts/docker/Dockerfile rename to scripts/docker/Dockerfile diff --git a/sphinx_doc/scripts/plantuml.jar b/scripts/plantuml.jar similarity index 100% rename from sphinx_doc/scripts/plantuml.jar rename to scripts/plantuml.jar diff --git a/sphinx_doc/scripts/publish-README.md b/scripts/publish-README.md similarity index 100% rename from sphinx_doc/scripts/publish-README.md rename to scripts/publish-README.md diff --git a/sphinx_doc/scripts/publish-index.html b/scripts/publish-index.html similarity index 100% rename from sphinx_doc/scripts/publish-index.html rename to scripts/publish-index.html diff --git a/sphinx_doc/scripts/requirements.txt b/scripts/requirements.txt similarity index 100% rename from sphinx_doc/scripts/requirements.txt rename to scripts/requirements.txt diff --git a/sphinx_doc/LICENSE b/sphinx_doc/LICENSE deleted file mode 100644 index 62da4936b3..0000000000 --- a/sphinx_doc/LICENSE +++ /dev/null @@ -1 +0,0 @@ -Apache 2.0 diff --git a/sphinx_doc/README.md b/sphinx_doc/README.md deleted file mode 100644 index ff7c1c8099..0000000000 --- a/sphinx_doc/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# Navigation2 Documentation - -This folder holds the source and configuration files used to generate the -[Navigation2 documentation](https://ros-planning.github.io/navigation2/) web site. - -Learn how to setup and generate documentation by reading the [howtos](https://ros-planning.github.io/navigation2/howtos/index.html). diff --git a/sphinx_doc/substitutions.txt b/substitutions.txt similarity index 100% rename from sphinx_doc/substitutions.txt rename to substitutions.txt diff --git a/sphinx_doc/tutorials/docs/images/Navigation2_on_real_Turtlebot3/rviz_after_launch_view.png b/tutorials/docs/images/Navigation2_on_real_Turtlebot3/rviz_after_launch_view.png similarity index 100% rename from sphinx_doc/tutorials/docs/images/Navigation2_on_real_Turtlebot3/rviz_after_launch_view.png rename to tutorials/docs/images/Navigation2_on_real_Turtlebot3/rviz_after_launch_view.png diff --git a/sphinx_doc/tutorials/docs/images/Navigation2_on_real_Turtlebot3/rviz_robot_navigating.png b/tutorials/docs/images/Navigation2_on_real_Turtlebot3/rviz_robot_navigating.png similarity index 100% rename from sphinx_doc/tutorials/docs/images/Navigation2_on_real_Turtlebot3/rviz_robot_navigating.png rename to tutorials/docs/images/Navigation2_on_real_Turtlebot3/rviz_robot_navigating.png diff --git a/sphinx_doc/tutorials/docs/images/Navigation2_on_real_Turtlebot3/rviz_send_goal.png b/tutorials/docs/images/Navigation2_on_real_Turtlebot3/rviz_send_goal.png similarity index 100% rename from sphinx_doc/tutorials/docs/images/Navigation2_on_real_Turtlebot3/rviz_send_goal.png rename to tutorials/docs/images/Navigation2_on_real_Turtlebot3/rviz_send_goal.png diff --git a/sphinx_doc/tutorials/docs/images/Navigation2_on_real_Turtlebot3/rviz_set_initial_pose.png b/tutorials/docs/images/Navigation2_on_real_Turtlebot3/rviz_set_initial_pose.png similarity index 100% rename from sphinx_doc/tutorials/docs/images/Navigation2_on_real_Turtlebot3/rviz_set_initial_pose.png rename to tutorials/docs/images/Navigation2_on_real_Turtlebot3/rviz_set_initial_pose.png diff --git a/sphinx_doc/tutorials/docs/images/Navigation2_on_real_Turtlebot3/rviz_slam_map_view.png b/tutorials/docs/images/Navigation2_on_real_Turtlebot3/rviz_slam_map_view.png similarity index 100% rename from sphinx_doc/tutorials/docs/images/Navigation2_on_real_Turtlebot3/rviz_slam_map_view.png rename to tutorials/docs/images/Navigation2_on_real_Turtlebot3/rviz_slam_map_view.png diff --git a/sphinx_doc/tutorials/docs/images/Navigation2_with_SLAM/navigation2_with_slam.gif b/tutorials/docs/images/Navigation2_with_SLAM/navigation2_with_slam.gif similarity index 100% rename from sphinx_doc/tutorials/docs/images/Navigation2_with_SLAM/navigation2_with_slam.gif rename to tutorials/docs/images/Navigation2_with_SLAM/navigation2_with_slam.gif diff --git a/sphinx_doc/tutorials/docs/images/Writing_new_Costmap2D_plugin/gradient_explanation.png b/tutorials/docs/images/Writing_new_Costmap2D_plugin/gradient_explanation.png similarity index 100% rename from sphinx_doc/tutorials/docs/images/Writing_new_Costmap2D_plugin/gradient_explanation.png rename to tutorials/docs/images/Writing_new_Costmap2D_plugin/gradient_explanation.png diff --git a/sphinx_doc/tutorials/docs/images/Writing_new_Costmap2D_plugin/gradient_layer_preview.gif b/tutorials/docs/images/Writing_new_Costmap2D_plugin/gradient_layer_preview.gif similarity index 100% rename from sphinx_doc/tutorials/docs/images/Writing_new_Costmap2D_plugin/gradient_layer_preview.gif rename to tutorials/docs/images/Writing_new_Costmap2D_plugin/gradient_layer_preview.gif diff --git a/sphinx_doc/tutorials/docs/images/Writing_new_Costmap2D_plugin/gradient_layer_run.png b/tutorials/docs/images/Writing_new_Costmap2D_plugin/gradient_layer_run.png similarity index 100% rename from sphinx_doc/tutorials/docs/images/Writing_new_Costmap2D_plugin/gradient_layer_run.png rename to tutorials/docs/images/Writing_new_Costmap2D_plugin/gradient_layer_run.png diff --git a/sphinx_doc/tutorials/docs/images/Writing_new_nav2planner_plugin/nav2_straightline_gif.gif b/tutorials/docs/images/Writing_new_nav2planner_plugin/nav2_straightline_gif.gif similarity index 100% rename from sphinx_doc/tutorials/docs/images/Writing_new_nav2planner_plugin/nav2_straightline_gif.gif rename to tutorials/docs/images/Writing_new_nav2planner_plugin/nav2_straightline_gif.gif diff --git a/sphinx_doc/tutorials/docs/navigation2_on_real_turtlebot3.rst b/tutorials/docs/navigation2_on_real_turtlebot3.rst similarity index 100% rename from sphinx_doc/tutorials/docs/navigation2_on_real_turtlebot3.rst rename to tutorials/docs/navigation2_on_real_turtlebot3.rst diff --git a/sphinx_doc/tutorials/docs/navigation2_with_slam.rst b/tutorials/docs/navigation2_with_slam.rst similarity index 100% rename from sphinx_doc/tutorials/docs/navigation2_with_slam.rst rename to tutorials/docs/navigation2_with_slam.rst diff --git a/sphinx_doc/tutorials/docs/navigation2_with_stvl.rst b/tutorials/docs/navigation2_with_stvl.rst similarity index 100% rename from sphinx_doc/tutorials/docs/navigation2_with_stvl.rst rename to tutorials/docs/navigation2_with_stvl.rst diff --git a/sphinx_doc/tutorials/docs/writing_new_costmap2d_plugin.rst b/tutorials/docs/writing_new_costmap2d_plugin.rst similarity index 100% rename from sphinx_doc/tutorials/docs/writing_new_costmap2d_plugin.rst rename to tutorials/docs/writing_new_costmap2d_plugin.rst diff --git a/sphinx_doc/tutorials/docs/writing_new_nav2planner_plugin.rst b/tutorials/docs/writing_new_nav2planner_plugin.rst similarity index 100% rename from sphinx_doc/tutorials/docs/writing_new_nav2planner_plugin.rst rename to tutorials/docs/writing_new_nav2planner_plugin.rst diff --git a/sphinx_doc/tutorials/index.rst b/tutorials/index.rst similarity index 100% rename from sphinx_doc/tutorials/index.rst rename to tutorials/index.rst