Metadata-Version: 2.1
Name: deepmodeling-sphinx
Version: 0.1.2
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: sphinx
Requires-Dist: htmlmin
Requires-Dist: jsmin
Requires-Dist: cssmin
Requires-Dist: jinja2

# deepmodeling_sphinx

This package should be used in all sphinx projects under the [@deepmodeling](https://github.com/deepmodeling) organization.

## Features

- Add the DeepModeling banner
- Add the ICP number to the footer
- Minify HTML, Javascript, and CSS files

## How to use it

### Setup

Add `deepmodeling_sphinx` to the requirements, as well as the `extensions` of `conf.py`:

```py
extensions = [
    'deepmodeling_sphinx',
]
```

### Render list of authors

The following directive can be used to render list of authors from `git shortlog`:

```rst
.. git-shortlog-authors::

```
