From 989917a8af6e9005b72c0e065a51d0ec1889a9f7 Mon Sep 17 00:00:00 2001 From: Jinzhe Zeng Date: Fri, 3 Feb 2023 20:09:52 -0500 Subject: [PATCH 1/2] docs: add the logo per https://github.com/deepmodeling/community/pull/21 --- README.md | 5 ++++- doc/conf.py | 1 + doc/logo.md | 5 +++++ doc/logo.svg | 1 + 4 files changed, 11 insertions(+), 1 deletion(-) create mode 100644 doc/logo.md create mode 100644 doc/logo.svg diff --git a/README.md b/README.md index ff28678895..000cdc2a8d 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,11 @@ +[![logo.svg](./doc/logo.svg)](./doc/logo.md) +-------------------------------------------------------------------------------- + DeePMD-kit Manual ======== [![GitHub release](https://img.shields.io/github/release/deepmodeling/deepmd-kit.svg?maxAge=86400)](https://github.com/deepmodeling/deepmd-kit/releases) [![doi:10.1016/j.cpc.2018.03.016](https://img.shields.io/badge/DOI-10.1016%2Fj.cpc.2018.03.016-blue)](https://doi.org/10.1016/j.cpc.2020.107206) -![Citations](https://citations.njzjz.win/10.1016/j.cpc.2018.03.016) +[![Citations](https://citations.njzjz.win/10.1016/j.cpc.2018.03.016)](https://badge.dimensions.ai/details/doi/10.1016/j.cpc.2018.03.016) [![offline packages](https://img.shields.io/github/downloads/deepmodeling/deepmd-kit/total?label=offline%20packages)](https://github.com/deepmodeling/deepmd-kit/releases) [![conda-forge](https://img.shields.io/conda/dn/conda-forge/deepmd-kit?color=red&label=conda-forge&logo=conda-forge)](https://anaconda.org/conda-forge/deepmd-kit) [![pip install](https://img.shields.io/pypi/dm/deepmd-kit?label=pip%20install)](https://pypi.org/project/deepmd-kit) diff --git a/doc/conf.py b/doc/conf.py index e165f9b887..831bad541e 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -287,6 +287,7 @@ def setup(app): # a list of builtin themes. # html_theme = "sphinx_rtd_theme" +html_logo = "logo.svg" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/doc/logo.md b/doc/logo.md new file mode 100644 index 0000000000..3257a684bd --- /dev/null +++ b/doc/logo.md @@ -0,0 +1,5 @@ +# Logo + +![logo.svg](Logo) + +The logo of DeePMD-kit is a beaver. Beavers were widely distributed in Europe and Asia but became nearly extinct due to hunting. Listed as a first-class state-protected animal in China, the population of beavers in China is less than the giant pandas. We hope that users of DeePMD-kit can enhance the awareness to protect beavers. diff --git a/doc/logo.svg b/doc/logo.svg new file mode 100644 index 0000000000..1d4937c0e7 --- /dev/null +++ b/doc/logo.svg @@ -0,0 +1 @@ + \ No newline at end of file From 21ac228b5f5ead1a752f84d8327e5ad76b2800ce Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Sat, 4 Feb 2023 01:10:27 +0000 Subject: [PATCH 2/2] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- doc/logo.svg | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/logo.svg b/doc/logo.svg index 1d4937c0e7..59e236df22 100644 --- a/doc/logo.svg +++ b/doc/logo.svg @@ -1 +1 @@ - \ No newline at end of file +