clean up SLAM docs (AtsushiSakai#572)

* clean up SLAM docs * clean up SLAM docs * clean up SLAM docs * clean up SLAM docs * clean up SLAM docs * clean up SLAM docs * clean up SLAM docs * clean up SLAM docs * clean up SLAM docs * clean up SLAM docs * clean up SLAM docs * clean up SLAM docs * clean up SLAM docs * clean up SLAM docs
ashutoshramola · Nov 21, 2021 · d34f3ca · d34f3ca
1 parent 1f4e5ed
commit d34f3ca
Show file tree

Hide file tree

Showing 35 changed files with 1,617 additions and 3,355 deletions.
diff --git a/Mapping/lidar_to_grid_map/lidar_to_grid_map_tutorial.ipynb b/Mapping/lidar_to_grid_map/lidar_to_grid_map_tutorial.ipynb
diff --git a/SLAM/EKFSLAM/ekf_slam.ipynb b/SLAM/EKFSLAM/ekf_slam.ipynb
diff --git a/SLAM/FastSLAM1/FastSLAM1.ipynb b/SLAM/FastSLAM1/FastSLAM1.ipynb
diff --git a/SLAM/FastSLAM1/animation.png b/SLAM/FastSLAM1/animation.png
diff --git a/SLAM/GraphBasedSLAM/LaTeX/.gitignore b/SLAM/GraphBasedSLAM/LaTeX/.gitignore
diff --git a/SLAM/GraphBasedSLAM/LaTeX/graphSLAM.bib b/SLAM/GraphBasedSLAM/LaTeX/graphSLAM.bib
diff --git a/SLAM/GraphBasedSLAM/LaTeX/graphSLAM_formulation.tex b/SLAM/GraphBasedSLAM/LaTeX/graphSLAM_formulation.tex
diff --git a/SLAM/GraphBasedSLAM/graphSLAM_SE2_example.ipynb b/SLAM/GraphBasedSLAM/graphSLAM_SE2_example.ipynb
diff --git a/SLAM/GraphBasedSLAM/graphSLAM_formulation.pdf b/SLAM/GraphBasedSLAM/graphSLAM_formulation.pdf
diff --git a/docs/_static/custom.css b/docs/_static/custom.css
@@ -0,0 +1,23 @@
+/*
+ * Necessary parts from
+ * Sphinx stylesheet -- basic theme
+ * absent from sphinx_rtd_theme
+ * (see https://github.com/readthedocs/sphinx_rtd_theme/issues/301)
+ * Ref https://github.com/PyAbel/PyAbel/commit/7e4dee81eac3f0a6955a85a4a42cf04a4e0d995c
+ */
+
+/* -- math display ---------------------------------------------------------- */
+
+span.eqno {
+    float: right;
+}
+
+span.eqno a.headerlink {
+    position: absolute;
+    z-index: 1;
+    visibility: hidden;
+}
+
+div.math:hover a.headerlink {
+    visibility: visible;
+}
diff --git a/docs/conf.py b/docs/conf.py
@@ -42,7 +42,6 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.mathjax',
     'sphinx.ext.viewcode',
-    'sphinx.ext.viewcode',
     'IPython.sphinxext.ipython_console_highlighting',
 ]
 
@@ -53,7 +52,7 @@
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = '_main.rst'
 
 # The master toctree document.
 master_doc = 'index'
@@ -100,6 +99,8 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
+html_css_files = ['custom.css']
+
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
 #

diff --git a/docs/getting_started.rst → docs/getting_started_main.rst b/docs/getting_started.rst → docs/getting_started_main.rst
diff --git a/docs/index.rst → docs/index_main.rst b/docs/index.rst → docs/index_main.rst
diff --git a/...s/aerial_navigation/aerial_navigation.rst → ...ial_navigation/aerial_navigation_main.rst b/...s/aerial_navigation/aerial_navigation.rst → ...ial_navigation/aerial_navigation_main.rst
diff --git a/docs/modules/appendix/appendix.rst → docs/modules/appendix/appendix_main.rst b/docs/modules/appendix/appendix.rst → docs/modules/appendix/appendix_main.rst
diff --git a/...modules/arm_navigation/arm_navigation.rst → ...es/arm_navigation/arm_navigation_main.rst b/...modules/arm_navigation/arm_navigation.rst → ...es/arm_navigation/arm_navigation_main.rst
diff --git a/docs/modules/introduction.rst → docs/modules/introduction_main.rst b/docs/modules/introduction.rst → docs/modules/introduction_main.rst
diff --git a/docs/modules/localization/localization.rst → ...odules/localization/localization_main.rst b/docs/modules/localization/localization.rst → ...odules/localization/localization_main.rst
diff --git a/docs/modules/mapping/mapping.rst → docs/modules/mapping/mapping_main.rst b/docs/modules/mapping/mapping.rst → docs/modules/mapping/mapping_main.rst
diff --git a/docs/modules/path_planning/path_planning.rst → ...ules/path_planning/path_planning_main.rst b/docs/modules/path_planning/path_planning.rst → ...ules/path_planning/path_planning_main.rst
diff --git a/docs/modules/path_tracking/path_tracking.rst → ...ules/path_tracking/path_tracking_main.rst b/docs/modules/path_tracking/path_tracking.rst → ...ules/path_tracking/path_tracking_main.rst
diff --git a/docs/modules/slam/FastSLAM1.rst b/docs/modules/slam/FastSLAM1.rst
@@ -2,14 +2,6 @@
 FastSLAM1.0
 -----------
 
-.. code-block:: ipython3
-
-    from IPython.display import Image
-    Image(filename="animation.png",width=600)
-
-
-
-
 .. image:: FastSLAM1_files/FastSLAM1_1_0.png
    :width: 600px
 
@@ -31,8 +23,6 @@ positions by FastSLAM.
 .. figure:: https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/SLAM/FastSLAM1/animation.gif
    :alt: gif
 
-   gif
-
 Introduction
 ~~~~~~~~~~~~
 
@@ -547,6 +537,9 @@ indices
 References
 ~~~~~~~~~~
 
-http://www.probabilistic-robotics.org/
+-  `PROBABILISTIC ROBOTICS`_
+
+-  `FastSLAM Lecture`_
 
-http://ais.informatik.uni-freiburg.de/teaching/ws12/mapping/pdf/slam10-fastslam.pdf
+.. _PROBABILISTIC ROBOTICS: http://www.probabilistic-robotics.org/
+.. _FastSLAM Lecture: http://ais.informatik.uni-freiburg.de/teaching/ws12/mapping/pdf/slam10-fastslam.pdf