Skip to content

Commit 11adb9e

Browse files
author
Saurav Agarwal
committed
reorganize and update doc
1 parent 3fe89dd commit 11adb9e

Some content is hidden

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

66 files changed

+413
-307
lines changed

.github/docker-base-action/action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ runs:
4848
with:
4949
provenance: false
5050
platforms: linux/amd64
51-
file: setup_utils/docker/Dockerfile
51+
file: utils/docker/Dockerfile
5252
build-args: |
5353
BASE_TAG=${{ inputs.base_tag }}
5454
BUILDKIT_CONTEXT_KEEP_GIT_DIR=1

.github/workflows/cd.yml

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717
fetch-depth: 0
1818

1919
- name: Install dependencies
20-
run: sudo bash ./setup_utils/install_dependencies.sh --boost --gmp --mpfr --eigen --cgal
20+
run: sudo bash ./utils/setup/install_dependencies.sh --boost --gmp --mpfr --eigen --cgal
2121

2222
- name: Build SDist
2323
run: pipx run build --sdist
@@ -106,6 +106,20 @@ jobs:
106106
github_token: ${{ secrets.GITHUB_TOKEN }}
107107
- name: cleanup
108108
run: docker system prune -a -f
109+
- name: 'CI docker base'
110+
uses: ./.github/docker-base-action
111+
with:
112+
base_tag: noble-torch2.5.1-cuda12.6.2
113+
github_token: ${{ secrets.GITHUB_TOKEN }}
114+
- name: cleanup
115+
run: docker system prune -a -f
116+
- name: 'CI docker base'
117+
uses: ./.github/docker-base-action
118+
with:
119+
base_tag: noble-torch2.5.1-cuda12.6.2-jazzy
120+
github_token: ${{ secrets.GITHUB_TOKEN }}
121+
- name: cleanup
122+
run: docker system prune -a -f
109123
- name: 'CI docker base'
110124
uses: ./.github/docker-base-action
111125
with:

doc/config/BaseDoxyfile

Lines changed: 289 additions & 213 deletions
Large diffs are not rendered by default.

doc/config/doxygen-awesome-interactive-toc.js

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,7 @@ class DoxygenAwesomeInteractiveToc {
5555
headerNode: document.getElementById(id)
5656
})
5757

58-
document.getElementById("doc-content")?.addEventListener("scroll", () => {
59-
DoxygenAwesomeInteractiveToc.update()
60-
})
58+
document.getElementById("doc-content")?.addEventListener("scroll",this.throttle(DoxygenAwesomeInteractiveToc.update, 100))
6159
})
6260
DoxygenAwesomeInteractiveToc.update()
6361
}
@@ -78,4 +76,16 @@ class DoxygenAwesomeInteractiveToc {
7876
active?.classList.add("active")
7977
active?.classList.remove("aboveActive")
8078
}
81-
}
79+
80+
static throttle(func, delay) {
81+
let lastCall = 0;
82+
return function (...args) {
83+
const now = new Date().getTime();
84+
if (now - lastCall < delay) {
85+
return;
86+
}
87+
lastCall = now;
88+
return setTimeout(() => {func(...args)}, delay);
89+
};
90+
}
91+
}

doc/config/doxygen-awesome.css

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -805,6 +805,8 @@ html.dark-mode iframe#MSearchResults {
805805
#nav-tree .item {
806806
height: var(--tree-item-height);
807807
line-height: var(--tree-item-height);
808+
overflow: hidden;
809+
text-overflow: ellipsis;
808810
}
809811

810812
#nav-tree .item > a:focus {
@@ -823,6 +825,8 @@ html.dark-mode iframe#MSearchResults {
823825
background-image: none;
824826
background-color: transparent;
825827
position: relative;
828+
color: var(--primary-color) !important;
829+
font-weight: 500;
826830
}
827831

828832
#nav-tree .selected::after {
@@ -1046,7 +1050,7 @@ blockquote::after {
10461050
blockquote p {
10471051
margin: var(--spacing-small) 0 var(--spacing-medium) 0;
10481052
}
1049-
.paramname {
1053+
.paramname, .paramname em {
10501054
font-weight: 600;
10511055
color: var(--primary-dark-color);
10521056
}
@@ -1096,7 +1100,7 @@ div.contents .toc {
10961100
border: 0;
10971101
border-left: 1px solid var(--separator-color);
10981102
border-radius: 0;
1099-
background-color: transparent;
1103+
background-color: var(--page-background-color);
11001104
box-shadow: none;
11011105
position: sticky;
11021106
top: var(--toc-sticky-top);
@@ -1749,7 +1753,7 @@ table.fieldtable th {
17491753
color: var(--tablehead-foreground);
17501754
}
17511755

1752-
table.fieldtable td.fieldtype, .fieldtable td.fieldname, .fieldtable td.fielddoc, .fieldtable th {
1756+
table.fieldtable td.fieldtype, .fieldtable td.fieldname, .fieldtable td.fieldinit, .fieldtable td.fielddoc, .fieldtable th {
17531757
border-bottom: 1px solid var(--separator-color);
17541758
border-right: 1px solid var(--separator-color);
17551759
}
@@ -1988,14 +1992,16 @@ hr {
19881992
}
19891993

19901994
.contents hr {
1991-
box-shadow: 100px 0 0 var(--separator-color),
1992-
-100px 0 0 var(--separator-color),
1993-
500px 0 0 var(--separator-color),
1994-
-500px 0 0 var(--separator-color),
1995-
1500px 0 0 var(--separator-color),
1996-
-1500px 0 0 var(--separator-color),
1997-
2000px 0 0 var(--separator-color),
1998-
-2000px 0 0 var(--separator-color);
1995+
box-shadow: 100px 0 var(--separator-color),
1996+
-100px 0 var(--separator-color),
1997+
500px 0 var(--separator-color),
1998+
-500px 0 var(--separator-color),
1999+
900px 0 var(--separator-color),
2000+
-900px 0 var(--separator-color),
2001+
1400px 0 var(--separator-color),
2002+
-1400px 0 var(--separator-color),
2003+
1900px 0 var(--separator-color),
2004+
-1900px 0 var(--separator-color);
19992005
}
20002006

20012007
.contents img, .contents .center, .contents center, .contents div.image object {

doc/manual/docker.md

Lines changed: 2 additions & 2 deletions

doc/manual/installation.md

Lines changed: 9 additions & 6 deletions

doc/manual/lpac.md

Lines changed: 9 additions & 9 deletions

doc/manual/quick_start.md

Lines changed: 1 addition & 1 deletion

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ manylinux-aarch64-image = "manylinux_2_28"
8787

8888
[tool.cibuildwheel.linux]
8989
environment = { PATH="/usr/local/cuda/bin:$PATH", LD_LIBRARY_PATH="/usr/local/cuda/lib64:$LD_LIBRARY_PATH" }
90-
before-all = "bash setup_utils/manylinux_2_28_before-all.sh"
90+
before-all = "bash utils/setup/manylinux_2_28_before-all.sh"
9191
repair-wheel-command = "auditwheel repair -w {dest_dir} {wheel}"
9292

9393
[tool.cibuildwheel.macos]
@@ -101,7 +101,7 @@ testpaths = ["python/tests"]
101101

102102
[tool.pylint]
103103
py-version = "3.10"
104-
ignore-paths = [".*/_version.py", "cppsrc/*", "setup_utils/*", "python/coverage_control/_version.py"]
104+
ignore-paths = [".*/_version.py", "cppsrc/*", "utils/*", "python/coverage_control/_version.py"]
105105
extension-pkg-allow-list = ["coverage_control._core"]
106106
reports.output-format = "colorized"
107107
similarities.ignore-imports = "yes"

0 commit comments

Comments
 (0)