Skip to content

Commit e04f1ad

Browse files
diamantopoulosdiamantopoulos
committed
Updated cf projects with a separate hmtl and ToC tree. Reduced navigation_depth to 4.
1 parent 4d7ed18 commit e04f1ad

11 files changed

+63
-19
lines changed

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -65,3 +65,4 @@ docsrc/doxyoutput
6565
# wherever you told Exhale containmentFolder is
6666
docsrc/api
6767

68+
repos_for_Doxygen

‎Makefile

+7-6
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,13 @@ clean:
2121
@$(SPHINXBUILD) -M clean "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
2222

2323
clone_local_cfdk_repo:
24-
git clone --depth=1 [email protected]:cloudFPGA/cFDK.git repos_for_Doxygen/cFDK
25-
git clone --depth=1 [email protected]:cloudFPGA/Dox.git repos_for_Doxygen/Dox
26-
git clone --depth=1 [email protected]:cloudFPGA/cFp_Monolithic.git repos_for_Doxygen/cFp_Monolithic
27-
git clone --depth=1 [email protected]:cloudFPGA/cFp_Vitis.git repos_for_Doxygen/cFp_Vitis
28-
git clone --depth=1 [email protected]:cloudFPGA/cFp_EchoThemisto.git repos_for_Doxygen/cFp_EchoThemisto
29-
git clone --depth=1 [email protected]:cloudFPGA/cFp_Uppercase.git repos_for_Doxygen/cFp_Uppercase
24+
git -C 'repos_for_Doxygen/cFDK' pull || git clone --depth=1 [email protected]:cloudFPGA/cFDK.git repos_for_Doxygen/cFDK
25+
git -C 'repos_for_Doxygen/Dox' pull || git clone --depth=1 [email protected]:cloudFPGA/Dox.git repos_for_Doxygen/Dox
26+
git -C 'repos_for_Doxygen/cFp_Monolithic' pull || git clone --depth=1 [email protected]:cloudFPGA/cFp_Monolithic.git repos_for_Doxygen/cFp_Monolithic
27+
git -C 'repos_for_Doxygen/cFp_Vitis' pull || git clone --depth=1 [email protected]:cloudFPGA/cFp_Vitis.git repos_for_Doxygen/cFp_Vitis
28+
git -C 'repos_for_Doxygen/cFp_EchoThemisto' pull || git clone --depth=1 [email protected]:cloudFPGA/cFp_EchoThemisto.git repos_for_Doxygen/cFp_EchoThemisto
29+
git -C 'repos_for_Doxygen/cFp_Uppercase' pull || git clone --depth=1 [email protected]:cloudFPGA/cFp_Uppercase.git repos_for_Doxygen/cFp_Uppercase
30+
git -C 'repos_for_Doxygen/cFp_Triangle' pull || git clone --depth=1 [email protected]:cloudFPGA/cFp_Triangle.git repos_for_Doxygen/cFp_Triangle
3031

3132
change_links:
3233
cd repos_for_Doxygen && python3 modify_links_cf.py && cd ../

‎docsrc/_static/custom.css

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.wy-nav-content {
2+
max-width: 55% !important;
3+
}
4+

‎docsrc/conf.py

+5-1
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@
108108
# Toc options
109109
'collapse_navigation': True,
110110
'sticky_navigation': True,
111-
'navigation_depth': 8,
111+
'navigation_depth': 4,
112112
'includehidden': True,
113113
'titles_only': False
114114
}
@@ -118,6 +118,10 @@
118118
# so a file named "default.css" will overwrite the builtin "default.css".
119119
html_static_path = ['_static', '../notes']
120120
html_extra_path = ['../notes']
121+
122+
html_css_files = [
123+
'custom.css',
124+
]
121125
# Custom sidebar templates, must be a dictionary that maps document names
122126
# to template names.
123127
#

‎docsrc/pages/project_repository.rst

+7-12
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,14 @@
22

33
.. _project_repository:
44

5-
.. mdinclude:: ./Project_repository.md
5+
.. include:: ./projects/projects_info.rst
66

7-
.. mdinclude:: ../../repos_for_Doxygen/cFp_EchoThemisto/README.md
7+
.. toctree::
88

9-
.. mdinclude:: ../../repos_for_Doxygen/cFp_Monolithic/README.md
9+
./projects/cFp_Monolithic
10+
./projects/cFp_Uppercase
11+
./projects/cFp_EchoThemisto
12+
./projects/cFp_Triangle
13+
./projects/cFp_Vitis
1014

11-
.. mdinclude:: ../../repos_for_Doxygen/cFp_Uppercase/README.md
12-
13-
.. mdinclude:: ../../repos_for_Doxygen/cFp_Vitis/README.md
14-
15-
.. mdinclude:: ../../repos_for_Doxygen/cFp_Vitis/ROLE/vision/hls/harris/README.md
16-
17-
.. mdinclude:: ../../repos_for_Doxygen/cFp_Vitis/HOST/vision/harris/README.md
18-
19-
.. mdinclude:: ../../repos_for_Doxygen/cFp_Vitis/ROLE/quantitative_finance/hls/mceuropeanengine/README.md
2015

‎docsrc/pages/projects/cFp_Monolithic.rst

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
2+
3+
.. _project_cFp_Monolithic:
4+
5+
.. mdinclude:: ../../../repos_for_Doxygen/cFp_Monolithic/README.md

‎docsrc/pages/projects/cFp_Triangle.rst

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
2+
3+
.. _project_cFp_Triangle:
4+
5+
.. mdinclude:: ../../../repos_for_Doxygen/cFp_Triangle/README.md

‎docsrc/pages/projects/cFp_Uppercase.rst

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
2+
3+
.. _project_cFp_Uppercase:
4+
5+
.. mdinclude:: ../../../repos_for_Doxygen/cFp_Uppercase/README.md

‎docsrc/pages/projects/cFp_Vitis.rst

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
2+
3+
.. _project_cFp_Vitis:
4+
5+
.. mdinclude:: ../../../repos_for_Doxygen/cFp_Vitis/README.md
6+
7+
.. mdinclude:: ../../../repos_for_Doxygen/cFp_Vitis/ROLE/vision/hls/harris/README.md
8+
9+
.. mdinclude:: ../../../repos_for_Doxygen/cFp_Vitis/HOST/vision/harris/README.md
10+
11+
.. mdinclude:: ../../../repos_for_Doxygen/cFp_Vitis/ROLE/quantitative_finance/hls/mceuropeanengine/README.md
12+

‎docsrc/pages/projects/projects_info.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Project repository
2+
3+
## What is a project + Relation/Small intro to cFDK
4+
5+
## Why & How to create a project
6+
7+
## Existing projects

‎docsrc/pages/projects/projects_info.rst

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
2+
3+
.. _projects_info:
4+
5+
.. mdinclude:: ./projects_info.md

0 commit comments

Comments
 (0)