Skip to content

Commit 92b538d

Browse files
njzjzpre-commit-ci[bot]coderabbitai[bot]
authored
docs: fix home page rendering (#2258)
<!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Reorganized sections in the HTML documentation to better highlight specific functionalities like Trajectory, Filtering, Isomers, Network, HTML5, and Fast. - **Style** - Simplified and adjusted layout styling by removing specific styling rules related to the `.hero` class for improved responsiveness. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
1 parent 558b8a1 commit 92b538d

File tree

4 files changed

+30
-92
lines changed

4 files changed

+30
-92
lines changed

docs/_static/css/custom.css

Lines changed: 1 addition & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -5,69 +5,10 @@
55
width: 100%;
66
aspect-ratio: 1.2877;
77
}
8-
9-
.hero {
10-
text-align: center;
11-
}
12-
13-
.hero .action,
14-
.hero p,
15-
.hero img,
16-
.hero h1 {
17-
margin: 1.8rem auto;
18-
}
19-
20-
.hero img {
8+
.reacnetgenerator-logo {
219
max-width: 100%;
2210
max-height: 280px;
2311
display: block;
2412
margin: 3rem auto 1.5rem;
2513
background: none !important;
2614
}
27-
28-
.hero p {
29-
max-width: 35rem;
30-
font-size: 1.6rem;
31-
line-height: 1.3;
32-
color: #6a8bad;
33-
}
34-
35-
.hero .action-button {
36-
display: inline-block;
37-
font-size: 1.2rem;
38-
color: #fff;
39-
background-color: #3eaf7c;
40-
padding: 0.8rem 1.6rem;
41-
border-radius: 4px;
42-
transition: background-color 0.1s ease;
43-
box-sizing: border-box;
44-
border-bottom: 1px solid #389d70;
45-
}
46-
47-
.features {
48-
border-top: 1px solid #eaecef;
49-
padding: 1.2rem 0;
50-
margin-top: 2.5rem;
51-
display: flex;
52-
flex-wrap: wrap;
53-
align-items: flex-start;
54-
align-content: stretch;
55-
justify-content: space-between;
56-
}
57-
58-
.features section {
59-
flex-grow: 1;
60-
flex-basis: 30%;
61-
max-width: 30%;
62-
}
63-
64-
@media (max-width: 719px) {
65-
.features {
66-
flex-direction: column;
67-
}
68-
69-
.features section {
70-
max-width: 100%;
71-
padding: 0 2.5rem;
72-
}
73-
}

docs/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@
4343
"sphinx_favicon",
4444
"deepmodeling_sphinx",
4545
"sphinxcontrib.bibtex",
46+
"sphinx_design",
4647
]
4748

4849
# Add any paths that contain templates here, relative to this directory.
@@ -111,6 +112,7 @@
111112
myst_enable_extensions = [
112113
"dollarmath",
113114
"colon_fence",
115+
"attrs_inline",
114116
]
115117
mathjax_path = (
116118
"https://cdnjs.cloudflare.com/ajax/libs/mathjax/3.2.2/es5/tex-mml-chtml.min.js"

docs/overall.md

Lines changed: 26 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,40 @@
1-
<header class="hero">
2-
3-
![Logo](_static/reacnetgen.svg)
1+
![Logo](_static/reacnetgen.svg){.reacnetgenerator-logo}
42

53
# ReacNetGenerator
64

75
An automatic reaction network generator for reactive molecular dynamics simulation
86

9-
<a href="/guide/install.html" class="nav-link action-button">Get Started</a>
10-
11-
</header>
7+
```{button-ref} ./guide/install
8+
:color: primary
9+
:shadow:
1210
13-
<div class="features">
14-
15-
## Trajectory
11+
Get Started
12+
```
1613

14+
::::{grid} 1 2 3 3
15+
:::{grid-item-card} Trajectory
1716
Processing of MD trajectory containing atomic coordinates or bond orders
18-
19-
## Filtering
20-
17+
:::
18+
:::{grid-item-card} Filtering
2119
Hidden Markov Model (HMM) based noise filtering
22-
23-
## Isomers
24-
25-
Isomers identifying accoarding to SMILES
26-
27-
## Network
28-
20+
:::
21+
:::{grid-item-card} Isomers
22+
Isomers identifying according to SMILES
23+
:::
24+
:::{grid-item-card} Network
2925
Generation of reaction network for visualization using force-directed algorithm
30-
31-
## HTML5
32-
26+
:::
27+
:::{grid-item-card} HTML5
3328
Showing an interactive web page
34-
35-
## Fast
36-
29+
:::
30+
:::{grid-item-card} Fast
3731
Parallel computing and performance optimization
38-
39-
</div>
32+
:::
33+
::::
4034

4135
<div class="bilitube" data-youtube="TI21SI9YPfo" data-bvid="BV175411N7uG">Loading...</div>
4236

43-
# Citation and contact
37+
## Citation and contact
4438

4539
```{bibliography}
4640
---
@@ -51,7 +45,7 @@ Zeng_PhysChemChemPhys_2020_v22_p683
5145

5246
jinzhe.zeng@rutgers.edu (Jinzhe Zeng), tzhu@lps.ecnu.edu.cn (Tong Zhu)
5347

54-
# Guide and Tutorials
48+
## Guide and Tutorials
5549

5650
You can install ReacNetGenerator with `conda`:
5751

@@ -60,14 +54,14 @@ conda install reacnetgenerator -c conda-forge
6054
reacnetgenerator -h
6155
```
6256

63-
See [the guide](guide/index) to learn how to install and use ReacNetGenerattor. We also provide [a series of tutorials](tutorial/index) to help you learn ReacNetGenerator.
57+
See [the guide](guide/index) to learn how to install and use ReacNetGenerator. We also provide [a series of tutorials](tutorial/index) to help you learn ReacNetGenerator.
6458

65-
# Awards
59+
## Awards
6660

6761
- The First Prize in 2019 (the 11th Session) Shanghai Computer Application Competition for College Students
6862
- The First Prize in 2019 (the 12th Session) Chinese Computer Design Competition for College Students
6963

70-
# Acknowledge
64+
## Acknowledge
7165

7266
- National Natural Science Foundation of China (Grants No. 91641116)
7367
- National Innovation and Entrepreneurship Training Program for Undergraduate (201910269080)

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@ docs = [
9696
"sphinxcontrib-bibtex>=2.6.0",
9797
# See https://github.com/mcmtroffaes/sphinxcontrib-bibtex/issues/345
9898
"setuptools",
99+
"sphinx-design",
99100
]
100101

101102
[tool.scikit-build]

0 commit comments

Comments
 (0)