Sphinx extension for DeepModeling projects.
Project description
deepmodeling_sphinx
This package should be used in all sphinx projects under the @deepmodeling organization.
Features
- Add the DeepModeling banner
- Add the ICP number to the footer
- Minify HTML, Javascript, and CSS files
- Supports dark mode for both the banner and the RTD theme
How to use it
Setup
Add deepmodeling_sphinx to the requirements, as well as the extensions of conf.py:
extensions = [
'deepmodeling_sphinx',
]
Projects outside DeepModeling can also use this extension but disable DeepModeling specific styles.
# default: True
enable_deepmodeling = False
Render list of authors
The following directive can be used to render list of authors from git shortlog:
.. git-shortlog-authors::
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
deepmodeling_sphinx-0.2.0.tar.gz
(18.4 kB
view details)
Built Distribution
File details
Details for the file deepmodeling_sphinx-0.2.0.tar.gz.
File metadata
- Download URL: deepmodeling_sphinx-0.2.0.tar.gz
- Upload date:
- Size: 18.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fe0e422df3a74dabb1f91a794c10fd4c6e523315029de83d16aca2a47fb36c4f |
|
| MD5 | 591d9b35ae29496376a51cecb1f608c5 |
|
| BLAKE2b-256 | ed6a0ce942fce9401bdb1852d2691f73d7ec1fdc68b549f3d5700f2722c70fb1 |
File details
Details for the file deepmodeling_sphinx-0.2.0-py3-none-any.whl.
File metadata
- Download URL: deepmodeling_sphinx-0.2.0-py3-none-any.whl
- Upload date:
- Size: 16.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4a07ddb1ad2428018af09ccea9355548970e6265ac0be2756b2c0340e495bff8 |
|
| MD5 | db75a8265d8d6a2da3ed2b823545239d |
|
| BLAKE2b-256 | 7c7fb93238be424cce54ae94e6f5a49f70bcd52bb35eb963eb9b1558a7038c78 |
