Skip to content

Commit 71532a0

Browse files
authored
Refactor and clean-up C++ API docs (#175)
* Refactor and clean-up C++ API docs * Remove port specification from livehtml target in Makefile
1 parent bc56ffb commit 71532a0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+360
-154
lines changed

docs/Makefile

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,8 @@ clean:
2323
%: Makefile
2424
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
2525

26+
xml:
27+
cd "$(SOURCEDIR)" && doxygen Doxyfile
28+
2629
livehtml:
27-
sphinx-autobuild --host 0.0.0.0 "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)
30+
sphinx-autobuild --host 0.0.0.0 -j auto -a -q "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)

docs/source/_static/css/custom.css

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ span.colon {
1717
margin-left: -1em;
1818
}
1919

20+
dl.cpp {
21+
font-size: 0.64rem;
22+
}
23+
2024
dl.cpp.objdesc,
2125
dl.py.objdesc {
2226
/* border: 0.05rem solid var(--md-primary-fg-color); */
@@ -28,6 +32,7 @@ dl.py.objdesc {
2832

2933
dl.cpp.objdesc>dt,
3034
dl.py.objdesc>dt {
35+
font-size: 0.64rem;
3136
padding-left: 0.5rem;
3237
padding-right: 0.5rem;
3338
}
File renamed without changes.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ License
44

55
IPC Toolkit is released under an MIT license, and all of its dependencies are under similar permissive licenses (MIT, Apache, or MPL).
66

7-
.. literalinclude:: ../../LICENSE
7+
.. literalinclude:: ../../../LICENSE
88
:language: md
99

1010
Citation
File renamed without changes.
File renamed without changes.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Python Bindings
22
===============
33

4-
.. include:: ../../python/README.md
4+
.. include:: ../../../python/README.md
55
:parser: myst_parser.sphinx_
66
:start-line: 10

docs/source/code_of_conduct.rst

Lines changed: 0 additions & 2 deletions
This file was deleted.

docs/source/conf.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@
101101
"private-members",
102102
)
103103
breathe_show_define_initializer = True
104-
# breathe_show_include = True
104+
breathe_show_include = True
105105

106106
autodoc_default_options = {
107107
"members": True,
@@ -176,14 +176,14 @@
176176
"icon": {"repo": "fontawesome/brands/github"},
177177

178178
"features": [
179-
"navigation.expand",
179+
"content.tabs.link",
180+
"navigation.footer",
180181
"navigation.tabs",
181182
"navigation.top",
182183
"navigation.tracking",
183184
"search.highlight",
184185
"search.share",
185186
"toc.follow",
186-
"content.tabs.link"
187187
],
188188

189189
"font": {

docs/source/contributing.rst

Lines changed: 0 additions & 2 deletions
This file was deleted.

0 commit comments

Comments
 (0)