Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/.gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
__pycache__
_build
source/python_api
source/python_api/*
!/source/python_api/index.rst
source/cpp_api
source/lua_api
**.pyc
5 changes: 5 additions & 0 deletions docs/source/_static/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
/* Hide third level of secondary sidebar onwards */
.md-sidebar--secondary .md-nav__list .md-nav__list .md-nav__list {
display: none;
}

8 changes: 6 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
]
master_doc = "index"
source_suffix = {'.rst': 'restructuredtext', '.md': 'restructuredtext'}
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "python_api/library_root.rst"]

# Syntax highlighting
pygments_style = "sphinx"
Expand All @@ -57,6 +57,8 @@
# HTML output configuration
html_theme = "sphinx_blue_robotics_theme"
html_static_path = ["_static"]
html_css_files = ['custom.css']

html_theme_options = {
"site_url": SITE_URL,
"repo_url": REPO_URL,
Expand Down Expand Up @@ -124,8 +126,10 @@
"rootFileName": "library_root.rst",
"doxygenStripFromPath": root_path,
"rootFileTitle": "API Reference",
"createTreeView": True,
"createTreeView": False,
"contentsDirectives": False,
"exhaleExecutesDoxygen": True,
"fullToctreeMaxDepth": 1,
"exhaleDoxygenStdin": f"INPUT = {os.path.join(root_path, 'brping')}",
"verboseBuild": True,
}
Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ A python implementation of the Blue Robotics Ping messaging protocol and a devic
:maxdepth: 2
:caption: Contents:

python_api/library_root
python_api/index
8 changes: 8 additions & 0 deletions docs/source/python_api/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
=============
API Reference
=============


.. include:: unabridged_api.rst.include
:start-after: --------