Skip to content

Commit a8ab8d9

Browse files
Saurav AgarwalSaurav Agarwal
authored andcommitted
Clean documentation
1 parent 84a7df2 commit a8ab8d9

File tree

9 files changed

+414
-247
lines changed

9 files changed

+414
-247
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The library provides a simulation environment, algorithms, and GNN-based archite
3434
> arXiv preprint arXiv:2401.04855 (2024).
3535
3636

37-
## Open Source Libraries
37+
## Open Source Libraries Dependency
3838
- [PyTorch](https://pytorch.org/)
3939
- [PyTorch Geometric](https://pytorch-geometric.readthedocs.io/en/latest/)
4040
- [Eigen](http://eigen.tuxfamily.org/index.php?title=Main_Page)

doc/Doxyfile

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,11 @@
44
PROJECT_NAME = "Coverage Control Library"
55
PROJECT_NUMBER = 1.0.0
66
USE_MDFILE_AS_MAINPAGE = doc/manual/README.md
7-
INPUT = doc/manual/ref_manual.txt \
8-
doc/manual/README.md \
7+
INPUT = doc/manual/README.md \
8+
doc/manual/ref_manual.txt \
99
doc/manual/installation.md \
1010
doc/manual/quick_start.md \
1111
doc/manual/coverage-control.md \
12-
doc/manual/docker.md \
13-
doc/manual/installation-from-source.md \
1412
doc/manual/lpac.md \
1513
cppsrc/core python/src \
1614
params \

doc/config/BaseDoxyfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1411,7 +1411,7 @@ HTML_DYNAMIC_MENUS = YES
14111411
# The default value is: NO.
14121412
# This tag requires that the tag GENERATE_HTML is set to YES.
14131413

1414-
HTML_DYNAMIC_SECTIONS = NO
1414+
HTML_DYNAMIC_SECTIONS = YES
14151415

14161416
# If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be
14171417
# dynamically folded and expanded in the generated HTML source code.
@@ -1703,7 +1703,7 @@ GENERATE_TREEVIEW = YES
17031703
# The default value is: NO.
17041704
# This tag requires that the tag GENERATE_HTML is set to YES.
17051705

1706-
FULL_SIDEBAR = NO
1706+
FULL_SIDEBAR = YES
17071707

17081708
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
17091709
# doxygen will group on one line in the generated HTML documentation.

0 commit comments

Comments
 (0)