generate docs

README.md

@@ -61,6 +61,12 @@ cd ~/.local/lib/python3.10/site-packages
 pybind11-stubgen -o . --ignore-invalid=all small_gicp
 ```
 
+## Documentation
+
+- Auto-generated docs: [C++](https://koide3.github.io/small_gicp/doc_cpp/index.html) [Python](https://koide3.github.io/small_gicp/doc_py/index.html)
+
+
+
 ## Usage (C++)
 
 The following examples assume `using namespace small_gicp` is placed somewhere.

docs/Doxyfile

@@ -1184,7 +1184,7 @@ GENERATE_HTML          = YES
 # The default directory is: html.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_OUTPUT            = html
+HTML_OUTPUT            = doc_cpp
 
 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
 # generated HTML page (for example: .htm, .php, .asp).

docs/Makefile

@@ -5,13 +5,24 @@ help:
 .PHONY: cpp
 cpp:
 	@echo "Building C++ documentation..."
-	doxygen Doxyfile
+	doxygen Doxyfile doc_cpp
 
 .PHONY: py
 py:
 	@echo "Building Python documentation..."
 	mkdir -p build && cd build && cmake ../../ -DBUILD_PYTHON_BINDINGS=ON && make -j
-	sphinx-build -b singlehtml . ./html_py/
+	sphinx-build -b singlehtml . ./doc_py/
+
+.PHONY: mkdocs
+mkdocs:
+	@echo "Building MkDocs documentation..."
+	cd .. && mkdocs build
 
 .PHONY: all
-all: cpp py
+all: cpp py mkdocs
+	@echo "All documentation built."
+
+.PHONY: deploy
+deploy:
+	@echo "Deploying documentation..."
+	cd .. && mkdocs gh-deploy

docs/index.md

@@ -0,0 +1,6 @@
+# small_gicp
+
+## Documentation
+
+- [C++](doc_cpp/index.html)
+- [Python](doc_py/index.html)

mkdocs.yml

@@ -0,0 +1,45 @@
+site_name: "small_gicp"
+site_author: k.koide
+repo_url: https://github.com/koide3/small_gicp
+site_url: https://github.com/koide3/small_gicp
+site_description: "small_gicp: Efficient and parallel algorithms for point cloud registration"
+
+theme: 
+    name: material
+    palette:
+        primary: indigo
+    front:
+        text: Roboto
+
+use_directory_urls: false
+
+markdown_extensions:
+    - meta
+    - attr_list
+    - admonition
+    - pymdownx.highlight:
+        anchor_linenums: true
+    - pymdownx.inlinehilite
+    - pymdownx.snippets
+    - pymdownx.superfences
+    - pymdownx.emoji:
+        emoji_index: !!python/name:materialx.emoji.twemoji
+        emoji_generator: !!python/name:materialx.emoji.to_svg
+    - fontawesome_markdown
+
+copyright: Copyright © 2024 Kenji Koide
+extra:
+    social:
+        - icon: material/home
+          link: https://staff.aist.go.jp/k.koide/
+        - icon: fontawesome/brands/github
+          link: https://github.com/koide3/small_gicp
+        - icon: fontawesome/brands/twitter
+          link: https://twitter.com/k_koide3
+
+extra_css:
+    - "css/custom.css"
+    - "https://maxcdn.bootstrapcdn.com/font-awesome/4.6.1/css/font-awesome.min.css"
+
+nav:
+    - 'index.md'