Skip to content

Commit de85e7e

Browse files
committed
files for building sphinx documentation
1 parent 48ccb16 commit de85e7e

9 files changed

Lines changed: 119 additions & 0 deletions

File tree

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,5 @@ python/src/openfloor.egg-info/top_level.txt
77
python/src/openfloor.egg-info/requires.txt
88
python/src/openfloor.egg-info/PKG-INFO
99
python/src/openfloor.egg-info/dependency_links.txt
10+
/python/src/sphinx_docs/_build/
11+
/python/src/sphinx_docs/build/
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Agent API Reference
2+
===================
3+
4+
.. automodule:: openfloor.agent
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
openfloor.dialog_event
2+
----------------------
3+
.. automodule:: openfloor.dialog_event
4+
:members:
5+
:undoc-members:
6+
:show-inheritance:
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
openfloor.envelope
2+
------------------
3+
.. automodule:: openfloor.envelope
4+
:members:
5+
:undoc-members:
6+
:show-inheritance:
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
openfloor.events
2+
----------------
3+
.. automodule:: openfloor.events
4+
:members:
5+
:undoc-members:
6+
:show-inheritance:
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
openfloor.json_serializable
2+
---------------------------
3+
.. automodule:: openfloor.json_serializable
4+
:members:
5+
:undoc-members:
6+
:show-inheritance:
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
openfloor.manifest
2+
------------------
3+
.. automodule:: openfloor.manifest
4+
:members:
5+
:undoc-members:
6+
:show-inheritance:

python/src/sphinx_docs/conf.py

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# This file only contains a selection of the most common options. For a full
4+
# list see the documentation:
5+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
6+
7+
# -- Path setup --------------------------------------------------------------
8+
9+
# If extensions (or modules to document with autodoc) are in another directory,
10+
# add these directories to sys.path here. If the directory is relative to the
11+
# documentation root, use os.path.abspath to make it absolute, like shown here.
12+
#
13+
import os
14+
import sys
15+
sys.path.insert(0, os.path.abspath('../../src'))
16+
17+
18+
19+
# -- Project information -----------------------------------------------------
20+
21+
project = 'openfloor'
22+
copyright = '2025, Open Voice Interoperability'
23+
author = 'Open Voice Interoperability'
24+
25+
# The full version, including alpha/beta/rc tags
26+
release = '1.0'
27+
28+
29+
# -- General configuration ---------------------------------------------------
30+
31+
# Add any Sphinx extension module names here, as strings. They can be
32+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
33+
# ones.
34+
35+
extensions = [
36+
"sphinx.ext.autodoc", # Extract docstrings
37+
"sphinx.ext.napoleon", # Google/NumPy-style docstrings
38+
"sphinx.ext.viewcode", # Links to source code
39+
"sphinx_autodoc_typehints", # Better type hints
40+
"sphinx.ext.inheritance_diagram", #include inheritance_diagram
41+
]
42+
43+
# Optional: pick a nicer theme
44+
html_theme = "furo" # or "sphinx_rtd_theme"
45+
46+
47+
# Add any paths that contain templates here, relative to this directory.
48+
templates_path = ['_templates']
49+
50+
# List of patterns, relative to source directory, that match files and
51+
# directories to ignore when looking for source files.
52+
# This pattern also affects html_static_path and html_extra_path.
53+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
54+
55+
56+
# -- Options for HTML output -------------------------------------------------
57+
58+
# The theme to use for HTML and HTML Help pages. See the documentation for
59+
# a list of builtin themes.
60+
#
61+
html_theme = 'furo'
62+
63+
# Add any paths that contain custom static files (such as style sheets) here,
64+
# relative to this directory. They are copied after the builtin static files,
65+
# so a file named "default.css" will overwrite the builtin "default.css".
66+
# html_static_path = ['_static']

python/src/sphinx_docs/index.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Welcome to OpenFloor's documentation!
2+
=====================================
3+
.. toctree::
4+
:maxdepth: 2
5+
:caption: API Reference:
6+
7+
api/agent
8+
api/dialog_event
9+
api/events
10+
api/json_serializable
11+
api/manifest
12+
api/envelope
13+

0 commit comments

Comments
 (0)