Skip to content

Commit

Permalink
Add an index.rst used for rosdoc2
Browse files Browse the repository at this point in the history
  • Loading branch information
christophfroehlich committed Apr 8, 2024
1 parent c4a0617 commit 121424a
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 0 deletions.
26 changes: 26 additions & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# 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 = "realtime_tools"
copyright = "2024, Stuart Glaser, Shane Loretz"
author = "Stuart Glaser, Shane Loretz"

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = []

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 = "alabaster"
html_static_path = ["_static"]
14 changes: 14 additions & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Welcome to the documentation for realtime_tools
===============================================

.. toctree::
:maxdepth: 2

C++ API <generated/index>


Indices and Search
==================

* :ref:`genindex`
* :ref:`search`

0 comments on commit 121424a

Please sign in to comment.