sphinx

Author: koide3

docs/Makefile

@@ -0,0 +1,14 @@
+.PHONY: help
+help:
+	@echo "make cpp|py"
+
+.PHONY: cpp
+cpp:
+	@echo "Building C++ documentation..."
+	doxygen Doxyfile
+
+.PHONY: py
+py:
+	@echo "Building Python documentation..."
+	pip wheel .. -w ./wheel
+	sphinx-build -b singlehtml . ./html_py/

docs/conf.py

@@ -0,0 +1,30 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'small_gicp'
+copyright = '2024, k.koide'
+author = 'k.koide'
+
+import os
+import sys
+sys.path.insert(0, os.path.abspath('./wheel/'))
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon']
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']

docs/index.rst

@@ -0,0 +1,22 @@
+.. small_gicp documentation master file, created by
+   sphinx-quickstart on Wed Jun  5 11:07:43 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to small_gicp's documentation!
+======================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   small_gicp
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/small_gicp.rst

@@ -0,0 +1,7 @@
+small\_gicp module
+==================
+
+.. automodule:: small_gicp
+   :members:
+   :undoc-members:
+   :show-inheritance: