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.1.tar.gz
(18.5 kB
view details)
Built Distribution
File details
Details for the file deepmodeling_sphinx-0.2.1.tar.gz.
File metadata
- Download URL: deepmodeling_sphinx-0.2.1.tar.gz
- Upload date:
- Size: 18.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 80556fe1a57f144e110c7d35988a8501e5083e47d3965403e864610d2bb66dfb |
|
| MD5 | b24b66458123e52f3c89c6eb9b0454c6 |
|
| BLAKE2b-256 | 8cc646131a2c7248c3e12fd5de9481618154aa664923b1f9e7993c35a75a2830 |
File details
Details for the file deepmodeling_sphinx-0.2.1-py3-none-any.whl.
File metadata
- Download URL: deepmodeling_sphinx-0.2.1-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 | 802a621650db8a6e32e1e7da2fcdf15dbfa3e4ead8c197781d2fd005d9b39464 |
|
| MD5 | 7d3c41c7ff5802b1a76bf25f2cc130fe |
|
| BLAKE2b-256 | a75d0dc457c4e01aca552c0497bb2f41f22495296b2ddb53a65d806c77257435 |
