Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: fix home page rendering #2258

Merged
merged 11 commits into from
Jul 18, 2024
Merged

docs: fix home page rendering #2258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
7357b73
docs: fix home page rendering
njzjz Jul 18, 2024
bf76806
Update overall.md
njzjz Jul 18, 2024
395762b
use sphinx-design
njzjz Jul 18, 2024
1782738
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jul 18, 2024
d1bd79c
fix
njzjz Jul 18, 2024
ba2493d
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jul 18, 2024
e3711b1
enable attrs_inline
njzjz Jul 18, 2024
8fda0f2
Update custom.css
njzjz Jul 18, 2024
c284316
Update docs/overall.md
njzjz Jul 18, 2024
1547767
Update custom.css
njzjz Jul 18, 2024
ae8b1ca
1 2 3 3
njzjz Jul 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 1 addition & 60 deletions docs/_static/css/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,69 +5,10 @@
width: 100%;
aspect-ratio: 1.2877;
}

.hero {
text-align: center;
}

.hero .action,
.hero p,
.hero img,
.hero h1 {
margin: 1.8rem auto;
}

.hero img {
.reacnetgenerator-logo {
max-width: 100%;
max-height: 280px;
display: block;
margin: 3rem auto 1.5rem;
background: none !important;
}

.hero p {
max-width: 35rem;
font-size: 1.6rem;
line-height: 1.3;
color: #6a8bad;
}

.hero .action-button {
display: inline-block;
font-size: 1.2rem;
color: #fff;
background-color: #3eaf7c;
padding: 0.8rem 1.6rem;
border-radius: 4px;
transition: background-color 0.1s ease;
box-sizing: border-box;
border-bottom: 1px solid #389d70;
}

.features {
border-top: 1px solid #eaecef;
padding: 1.2rem 0;
margin-top: 2.5rem;
display: flex;
flex-wrap: wrap;
align-items: flex-start;
align-content: stretch;
justify-content: space-between;
}

.features section {
flex-grow: 1;
flex-basis: 30%;
max-width: 30%;
}

@media (max-width: 719px) {
.features {
flex-direction: column;
}

.features section {
max-width: 100%;
padding: 0 2.5rem;
}
}
2 changes: 2 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
"sphinx_favicon",
"deepmodeling_sphinx",
"sphinxcontrib.bibtex",
"sphinx_design",
]

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -111,6 +112,7 @@
myst_enable_extensions = [
"dollarmath",
"colon_fence",
"attrs_inline",
]
mathjax_path = (
"https://cdnjs.cloudflare.com/ajax/libs/mathjax/3.2.2/es5/tex-mml-chtml.min.js"
Expand Down
58 changes: 26 additions & 32 deletions docs/overall.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,46 +1,40 @@
<header class="hero">

![Logo](_static/reacnetgen.svg)
![Logo](_static/reacnetgen.svg){.reacnetgenerator-logo}

# ReacNetGenerator

An automatic reaction network generator for reactive molecular dynamics simulation

<a href="/guide/install.html" class="nav-link action-button">Get Started</a>

</header>
```{button-ref} ./guide/install
:color: primary
:shadow:

<div class="features">

## Trajectory
Get Started
```

::::{grid} 1 2 3 3
:::{grid-item-card} Trajectory
Processing of MD trajectory containing atomic coordinates or bond orders

## Filtering

:::
:::{grid-item-card} Filtering
Hidden Markov Model (HMM) based noise filtering

## Isomers

Isomers identifying accoarding to SMILES

## Network

:::
:::{grid-item-card} Isomers
Isomers identifying according to SMILES
njzjz marked this conversation as resolved.
Show resolved Hide resolved
:::
:::{grid-item-card} Network
Generation of reaction network for visualization using force-directed algorithm

## HTML5

:::
:::{grid-item-card} HTML5
Showing an interactive web page

## Fast

:::
:::{grid-item-card} Fast
Parallel computing and performance optimization

</div>
:::
::::

Comment on lines +14 to +33
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix the typo in the description for "Isomers".

There is a typo in the description for "Isomers".

- Isomers identifying accoarding to SMILES
+ Isomers identifying according to SMILES
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
::::{grid} 1 2 3 3
:::{grid-item-card} Trajectory
Processing of MD trajectory containing atomic coordinates or bond orders
## Filtering
:::
:::{grid-item-card} Filtering
Hidden Markov Model (HMM) based noise filtering
## Isomers
Isomers identifying accoarding to SMILES
## Network
:::
:::{grid-item-card} Isomers
Isomers identifying according to SMILES
:::
:::{grid-item-card} Network
Generation of reaction network for visualization using force-directed algorithm
## HTML5
:::
:::{grid-item-card} HTML5
Showing an interactive web page
## Fast
:::
:::{grid-item-card} Fast
Parallel computing and performance optimization
</div>
:::
::::
:::{grid-item-card} Isomers
Isomers identifying according to SMILES
:::
Tools
LanguageTool

[duplication] ~21-~21: Possible typo: you repeated a word
Context: ...noise filtering ::: :::{grid-item-card} Isomers Isomers identifying according to SMILES ::: :::...

(ENGLISH_WORD_REPEAT_RULE)

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

# Citation and contact
## Citation and contact

```{bibliography}
---
Expand All @@ -51,7 +45,7 @@ Zeng_PhysChemChemPhys_2020_v22_p683

[email protected] (Jinzhe Zeng), [email protected] (Tong Zhu)

# Guide and Tutorials
## Guide and Tutorials

You can install ReacNetGenerator with `conda`:

Expand All @@ -60,14 +54,14 @@ conda install reacnetgenerator -c conda-forge
reacnetgenerator -h
```

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.
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.

# Awards
## Awards

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

# Acknowledge
## Acknowledge

- National Natural Science Foundation of China (Grants No. 91641116)
- National Innovation and Entrepreneurship Training Program for Undergraduate (201910269080)
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ docs = [
"sphinxcontrib-bibtex>=2.6.0",
# See https://github.com/mcmtroffaes/sphinxcontrib-bibtex/issues/345
"setuptools",
"sphinx-design",
]

[tool.scikit-build]
Expand Down
Loading