Merge pull request #111 from kurusugawa-computer/update-docs

ReadTheDocsにpublishするための準備
kurusugawa-computer · Oct 25, 2022 · a46ff29 · a46ff29
2 parents 7f37ba0 + 1de1776
commit a46ff29
Show file tree

Hide file tree

Showing 20 changed files with 1,058 additions and 928 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -1,6 +1,6 @@
 version: 2
 python:
-  version: 3.8
+  version: 3.10
   install:
     - requirements: docs/requirements.txt
     - method: pip

diff --git a/docs/_static/.gitkeep b/docs/_static/.gitkeep
diff --git a/docs/conf.py b/docs/conf.py
@@ -27,7 +27,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["recommonmark"]
+extensions = ["myst_parser"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/index.rst b/docs/index.rst
@@ -0,0 +1,11 @@
+
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   user_guide/command_sample.rst
+   user_guide/kitti_3d_object_detection.md
+   user_guide/annofab_point_cloud_format.md
+
+
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,3 +1,3 @@
-sphinx==3.5.2
-pydata-sphinx-theme==0.4.3
+sphinx==5.2.3
+pydata-sphinx-theme==0.9.0
 recommonmark=="0.7.1"
diff --git a/docs/user_guide/annofab_point_cloud_format.md b/docs/user_guide/annofab_point_cloud_format.md
@@ -1,4 +1,3 @@
-
 # Annofab点群形式（KITTIベース）
 
 ## 概要