Move docs to root directory (ros-navigation#7)

* Move docs to root directory * Create CNAME * Fix issue ros-navigation#6 * Minor whitespace change to trigger a CircleCI build of the PR Co-authored-by: Steve Macenski <[email protected]>
pradyum · Apr 28, 2020 · c1c2d4e · c1c2d4e
1 parent ebb1461
commit c1c2d4e
Show file tree

Hide file tree

Showing 80 changed files with 7 additions and 11 deletions.
diff --git 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:
@@ -67,7 +67,7 @@ jobs:
       - persist_to_workspace:
           root: nav2_docs
           paths:
-            - sphinx_doc
+            - _build 
   docs_publish:
     executor: docs_exec
     steps:

diff --git a/sphinx_doc/Makefile → Makefile b/sphinx_doc/Makefile → Makefile
@@ -52,6 +52,7 @@ publish:
 	rm -fr $(PUBLISHDIR)/*
 	cp -r $(BUILDDIR)/html/* $(PUBLISHDIR)
 	cp scripts/.nojekyll $(PUBLISHDIR)/.nojekyll
+	cp scripts/CNAME $(PUBLISHDIR)/CNAME
 	cd $(PUBLISHDIR) && \
 	git add -A && \
 	git diff-index --quiet HEAD || \

diff --git a/README.md b/README.md
@@ -5,3 +5,4 @@ This folder holds the source and configuration files used to generate the
 [Navigation2 documentation](https://navigation.ros.org) web site.
 
 Build the docs locally with `make html` and you'll find the built docs entry point in `_build/html/index.html`.
+
diff --git a/...c/_themes/otc_tcs_sphinx_theme/.gitignore → _themes/otc_tcs_sphinx_theme/.gitignore b/...c/_themes/otc_tcs_sphinx_theme/.gitignore → _themes/otc_tcs_sphinx_theme/.gitignore
diff --git a/.../_themes/otc_tcs_sphinx_theme/layout.html → _themes/otc_tcs_sphinx_theme/layout.html b/.../_themes/otc_tcs_sphinx_theme/layout.html → _themes/otc_tcs_sphinx_theme/layout.html
diff --git a/...c/_themes/otc_tcs_sphinx_theme/readme.rst → _themes/otc_tcs_sphinx_theme/readme.rst b/...c/_themes/otc_tcs_sphinx_theme/readme.rst → _themes/otc_tcs_sphinx_theme/readme.rst
diff --git a/...otc_tcs_sphinx_theme/static/tcs_theme.css → ...otc_tcs_sphinx_theme/static/tcs_theme.css b/...otc_tcs_sphinx_theme/static/tcs_theme.css → ...otc_tcs_sphinx_theme/static/tcs_theme.css
diff --git a/.../otc_tcs_sphinx_theme/static/tcs_theme.js → .../otc_tcs_sphinx_theme/static/tcs_theme.js b/.../otc_tcs_sphinx_theme/static/tcs_theme.js → .../otc_tcs_sphinx_theme/static/tcs_theme.js
diff --git a/...c/_themes/otc_tcs_sphinx_theme/theme.conf → _themes/otc_tcs_sphinx_theme/theme.conf b/...c/_themes/otc_tcs_sphinx_theme/theme.conf → _themes/otc_tcs_sphinx_theme/theme.conf
diff --git a/sphinx_doc/about/images/coming_soon.jpeg → about/images/coming_soon.jpeg b/sphinx_doc/about/images/coming_soon.jpeg → about/images/coming_soon.jpeg
diff --git a/..._doc/about/images/move_base_compare_2.png → about/images/move_base_compare_2.png b/..._doc/about/images/move_base_compare_2.png → about/images/move_base_compare_2.png
diff --git a/sphinx_doc/about/images/rb1.png → about/images/rb1.png b/sphinx_doc/about/images/rb1.png → about/images/rb1.png
diff --git a/sphinx_doc/about/images/rover.png → about/images/rover.png b/sphinx_doc/about/images/rover.png → about/images/rover.png
diff --git a/sphinx_doc/about/images/tb2.png → about/images/tb2.png b/sphinx_doc/about/images/tb2.png → about/images/tb2.png
diff --git a/sphinx_doc/about/images/tb3.png → about/images/tb3.png b/sphinx_doc/about/images/tb3.png → about/images/tb3.png
diff --git a/sphinx_doc/about/images/tiago.png → about/images/tiago.png b/sphinx_doc/about/images/tiago.png → about/images/tiago.png
diff --git a/sphinx_doc/about/images/yunji.png → about/images/yunji.png b/sphinx_doc/about/images/yunji.png → about/images/yunji.png
diff --git a/sphinx_doc/about/index.rst → about/index.rst b/sphinx_doc/about/index.rst → about/index.rst
diff --git a/sphinx_doc/about/robots.rst → about/robots.rst b/sphinx_doc/about/robots.rst → about/robots.rst
diff --git a/sphinx_doc/about/ros1_comparison.rst → about/ros1_comparison.rst b/sphinx_doc/about/ros1_comparison.rst → about/ros1_comparison.rst
diff --git a/...uild_docs/build_troubleshooting_guide.rst → ...uild_docs/build_troubleshooting_guide.rst b/...uild_docs/build_troubleshooting_guide.rst → ...uild_docs/build_troubleshooting_guide.rst
diff --git a/sphinx_doc/build_instructions/index.rst → build_instructions/index.rst b/sphinx_doc/build_instructions/index.rst → build_instructions/index.rst
diff --git a/sphinx_doc/concepts/index.rst → concepts/index.rst b/sphinx_doc/concepts/index.rst → concepts/index.rst
diff --git a/sphinx_doc/conf.py → conf.py b/sphinx_doc/conf.py → conf.py
diff --git a/...figuration/configuring-the-controller.rst → configuration/configuring-the-controller.rst b/...figuration/configuring-the-controller.rst → configuration/configuring-the-controller.rst
diff --git a/...nfiguration/dwb-plugins/goal-checkers.rst → configuration/dwb-plugins/goal-checkers.rst b/...nfiguration/dwb-plugins/goal-checkers.rst → configuration/dwb-plugins/goal-checkers.rst
diff --git a/...ration/dwb-plugins/trajectory-critics.rst → ...ration/dwb-plugins/trajectory-critics.rst b/...ration/dwb-plugins/trajectory-critics.rst → ...ration/dwb-plugins/trajectory-critics.rst
diff --git a/...ion/dwb-plugins/trajectory-generators.rst → ...ion/dwb-plugins/trajectory-generators.rst b/...ion/dwb-plugins/trajectory-generators.rst → ...ion/dwb-plugins/trajectory-generators.rst
diff --git a/sphinx_doc/configuration/index.rst → configuration/index.rst b/sphinx_doc/configuration/index.rst → configuration/index.rst
diff --git a/...c/configuration/params/tunable-params.rst → configuration/params/tunable-params.rst b/...c/configuration/params/tunable-params.rst → configuration/params/tunable-params.rst
diff --git a/sphinx_doc/contribute/index.rst → contribute/index.rst b/sphinx_doc/contribute/index.rst → contribute/index.rst
diff --git a/...s/navigation_with_recovery_behaviours.gif → ...s/navigation_with_recovery_behaviours.gif b/...s/navigation_with_recovery_behaviours.gif → ...s/navigation_with_recovery_behaviours.gif
diff --git a/sphinx_doc/getting_started/index.rst → getting_started/index.rst b/sphinx_doc/getting_started/index.rst → getting_started/index.rst
diff --git a/sphinx_doc/images/architectural_diagram.png → images/architectural_diagram.png b/sphinx_doc/images/architectural_diagram.png → images/architectural_diagram.png
diff --git a/sphinx_doc/images/favicon-16x16.png → images/favicon-16x16.png b/sphinx_doc/images/favicon-16x16.png → images/favicon-16x16.png
diff --git a/sphinx_doc/images/favicon-48x48.png → images/favicon-48x48.png b/sphinx_doc/images/favicon-48x48.png → images/favicon-48x48.png
diff --git a/...x_doc/images/gazebo/gazebo_turtlebot1.png → images/gazebo/gazebo_turtlebot1.png b/...x_doc/images/gazebo/gazebo_turtlebot1.png → images/gazebo/gazebo_turtlebot1.png
diff --git a/sphinx_doc/images/logo_dark.png → images/logo_dark.png b/sphinx_doc/images/logo_dark.png → images/logo_dark.png
diff --git a/sphinx_doc/images/logo_dark_120w.png → images/logo_dark_120w.png b/sphinx_doc/images/logo_dark_120w.png → images/logo_dark_120w.png
diff --git a/sphinx_doc/images/logo_white.png → images/logo_white.png b/sphinx_doc/images/logo_white.png → images/logo_white.png
diff --git a/sphinx_doc/images/logo_white_200w.png → images/logo_white_200w.png b/sphinx_doc/images/logo_white_200w.png → images/logo_white_200w.png
diff --git a/sphinx_doc/images/rviz/navigate-to-pose.png → images/rviz/navigate-to-pose.png b/sphinx_doc/images/rviz/navigate-to-pose.png → images/rviz/navigate-to-pose.png
diff --git a/sphinx_doc/images/rviz/navigating.png → images/rviz/navigating.png b/sphinx_doc/images/rviz/navigating.png → images/rviz/navigating.png
diff --git a/sphinx_doc/images/rviz/navstack-ready.png → images/rviz/navstack-ready.png b/sphinx_doc/images/rviz/navstack-ready.png → images/rviz/navstack-ready.png
diff --git a/sphinx_doc/images/rviz/rviz-not-started.png → images/rviz/rviz-not-started.png b/sphinx_doc/images/rviz/rviz-not-started.png → images/rviz/rviz-not-started.png
diff --git a/...doc/images/rviz/rviz-set-initial-pose.png → images/rviz/rviz-set-initial-pose.png b/...doc/images/rviz/rviz-set-initial-pose.png → images/rviz/rviz-set-initial-pose.png
diff --git a/sphinx_doc/images/rviz/rviz_initial.png → images/rviz/rviz_initial.png b/sphinx_doc/images/rviz/rviz_initial.png → images/rviz/rviz_initial.png
diff --git a/sphinx_doc/index.rst → index.rst b/sphinx_doc/index.rst → index.rst
diff --git a/sphinx_doc/make.bat → make.bat b/sphinx_doc/make.bat → make.bat
diff --git a/sphinx_doc/migration/Dashing.rst → migration/Dashing.rst b/sphinx_doc/migration/Dashing.rst → migration/Dashing.rst
diff --git a/sphinx_doc/migration/Eloquent.rst → migration/Eloquent.rst b/sphinx_doc/migration/Eloquent.rst → migration/Eloquent.rst
diff --git a/sphinx_doc/migration/index.rst → migration/index.rst b/sphinx_doc/migration/index.rst → migration/index.rst
diff --git a/sphinx_doc/plugins/index.rst → plugins/index.rst b/sphinx_doc/plugins/index.rst → plugins/index.rst
diff --git a/sphinx_doc/scripts/.nojekyll → scripts/.nojekyll b/sphinx_doc/scripts/.nojekyll → scripts/.nojekyll
diff --git a/scripts/CNAME b/scripts/CNAME
@@ -0,0 +1 @@
+navigation.ros.org
diff --git a/sphinx_doc/scripts/_nojekyll → scripts/_nojekyll b/sphinx_doc/scripts/_nojekyll → scripts/_nojekyll
diff --git a/sphinx_doc/scripts/docker/Dockerfile → scripts/docker/Dockerfile b/sphinx_doc/scripts/docker/Dockerfile → scripts/docker/Dockerfile
diff --git a/sphinx_doc/scripts/plantuml.jar → scripts/plantuml.jar b/sphinx_doc/scripts/plantuml.jar → scripts/plantuml.jar
diff --git a/sphinx_doc/scripts/publish-README.md → scripts/publish-README.md b/sphinx_doc/scripts/publish-README.md → scripts/publish-README.md
diff --git a/sphinx_doc/scripts/publish-index.html → scripts/publish-index.html b/sphinx_doc/scripts/publish-index.html → scripts/publish-index.html
diff --git a/sphinx_doc/scripts/requirements.txt → scripts/requirements.txt b/sphinx_doc/scripts/requirements.txt → scripts/requirements.txt
diff --git a/sphinx_doc/LICENSE b/sphinx_doc/LICENSE
diff --git a/sphinx_doc/README.md b/sphinx_doc/README.md
diff --git a/sphinx_doc/substitutions.txt → substitutions.txt b/sphinx_doc/substitutions.txt → substitutions.txt
diff --git a/...eal_Turtlebot3/rviz_after_launch_view.png → ...eal_Turtlebot3/rviz_after_launch_view.png b/...eal_Turtlebot3/rviz_after_launch_view.png → ...eal_Turtlebot3/rviz_after_launch_view.png
diff --git a/...real_Turtlebot3/rviz_robot_navigating.png → ...real_Turtlebot3/rviz_robot_navigating.png b/...real_Turtlebot3/rviz_robot_navigating.png → ...real_Turtlebot3/rviz_robot_navigating.png
diff --git a/...on2_on_real_Turtlebot3/rviz_send_goal.png → ...on2_on_real_Turtlebot3/rviz_send_goal.png b/...on2_on_real_Turtlebot3/rviz_send_goal.png → ...on2_on_real_Turtlebot3/rviz_send_goal.png
diff --git a/...real_Turtlebot3/rviz_set_initial_pose.png → ...real_Turtlebot3/rviz_set_initial_pose.png b/...real_Turtlebot3/rviz_set_initial_pose.png → ...real_Turtlebot3/rviz_set_initial_pose.png
diff --git a/...on_real_Turtlebot3/rviz_slam_map_view.png → ...on_real_Turtlebot3/rviz_slam_map_view.png b/...on_real_Turtlebot3/rviz_slam_map_view.png → ...on_real_Turtlebot3/rviz_slam_map_view.png
diff --git a/...tion2_with_SLAM/navigation2_with_slam.gif → ...tion2_with_SLAM/navigation2_with_slam.gif b/...tion2_with_SLAM/navigation2_with_slam.gif → ...tion2_with_SLAM/navigation2_with_slam.gif
diff --git a/...Costmap2D_plugin/gradient_explanation.png → ...Costmap2D_plugin/gradient_explanation.png b/...Costmap2D_plugin/gradient_explanation.png → ...Costmap2D_plugin/gradient_explanation.png
diff --git a/...stmap2D_plugin/gradient_layer_preview.gif → ...stmap2D_plugin/gradient_layer_preview.gif b/...stmap2D_plugin/gradient_layer_preview.gif → ...stmap2D_plugin/gradient_layer_preview.gif
diff --git a/...w_Costmap2D_plugin/gradient_layer_run.png → ...w_Costmap2D_plugin/gradient_layer_run.png b/...w_Costmap2D_plugin/gradient_layer_run.png → ...w_Costmap2D_plugin/gradient_layer_run.png
diff --git a/...2planner_plugin/nav2_straightline_gif.gif → ...2planner_plugin/nav2_straightline_gif.gif b/...2planner_plugin/nav2_straightline_gif.gif → ...2planner_plugin/nav2_straightline_gif.gif
diff --git a/...s/docs/navigation2_on_real_turtlebot3.rst → ...s/docs/navigation2_on_real_turtlebot3.rst b/...s/docs/navigation2_on_real_turtlebot3.rst → ...s/docs/navigation2_on_real_turtlebot3.rst
diff --git a/.../tutorials/docs/navigation2_with_slam.rst → tutorials/docs/navigation2_with_slam.rst b/.../tutorials/docs/navigation2_with_slam.rst → tutorials/docs/navigation2_with_slam.rst
diff --git a/.../tutorials/docs/navigation2_with_stvl.rst → tutorials/docs/navigation2_with_stvl.rst b/.../tutorials/docs/navigation2_with_stvl.rst → tutorials/docs/navigation2_with_stvl.rst
diff --git a/...als/docs/writing_new_costmap2d_plugin.rst → ...als/docs/writing_new_costmap2d_plugin.rst b/...als/docs/writing_new_costmap2d_plugin.rst → ...als/docs/writing_new_costmap2d_plugin.rst
diff --git a/...s/docs/writing_new_nav2planner_plugin.rst → ...s/docs/writing_new_nav2planner_plugin.rst b/...s/docs/writing_new_nav2planner_plugin.rst → ...s/docs/writing_new_nav2planner_plugin.rst
diff --git a/sphinx_doc/tutorials/index.rst → tutorials/index.rst b/sphinx_doc/tutorials/index.rst → tutorials/index.rst
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,3 +5,4 @@ This folder holds the source and configuration files used to generate the
		[Navigation2 documentation](https://navigation.ros.org) web site.

		Build the docs locally with `make html` and you'll find the built docs entry point in `_build/html/index.html`.