Skip to content

Commit d7f571a

Browse files
dgarcia360ES-Alexander
authored andcommitted
docs: remove unecessary content
1 parent 4f18da3 commit d7f571a

File tree

5 files changed

+22
-4
lines changed

5 files changed

+22
-4
lines changed

docs/.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
__pycache__
22
_build
3-
source/python_api
3+
source/python_api/*
4+
!/source/python_api/index.rst
45
source/cpp_api
56
source/lua_api
67
**.pyc

docs/source/_static/custom.css

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/* Hide third level of secondary sidebar onwards */
2+
.md-sidebar--secondary .md-nav__list .md-nav__list .md-nav__list {
3+
display: none;
4+
}
5+

docs/source/conf.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
]
4040
master_doc = "index"
4141
source_suffix = {'.rst': 'restructuredtext', '.md': 'restructuredtext'}
42-
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
42+
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "python_api/library_root.rst"]
4343

4444
# Syntax highlighting
4545
pygments_style = "sphinx"
@@ -57,6 +57,8 @@
5757
# HTML output configuration
5858
html_theme = "sphinx_blue_robotics_theme"
5959
html_static_path = ["_static"]
60+
html_css_files = ['custom.css']
61+
6062
html_theme_options = {
6163
"site_url": SITE_URL,
6264
"repo_url": REPO_URL,
@@ -124,8 +126,10 @@
124126
"rootFileName": "library_root.rst",
125127
"doxygenStripFromPath": root_path,
126128
"rootFileTitle": "API Reference",
127-
"createTreeView": True,
129+
"createTreeView": False,
130+
"contentsDirectives": False,
128131
"exhaleExecutesDoxygen": True,
132+
"fullToctreeMaxDepth": 1,
129133
"exhaleDoxygenStdin": f"INPUT = {os.path.join(root_path, 'brping')}",
130134
"verboseBuild": True,
131135
}

docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ A python implementation of the Blue Robotics Ping messaging protocol and a devic
88
:maxdepth: 2
99
:caption: Contents:
1010

11-
python_api/library_root
11+
python_api/index

docs/source/python_api/index.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
=============
2+
API Reference
3+
=============
4+
5+
6+
.. include:: unabridged_api.rst.include
7+
:start-after: --------
8+

0 commit comments

Comments
 (0)