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.4.tar.gz
(19.3 kB
view details)
Built Distribution
File details
Details for the file deepmodeling_sphinx-0.2.4.tar.gz.
File metadata
- Download URL: deepmodeling_sphinx-0.2.4.tar.gz
- Upload date:
- Size: 19.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7e547945d083b3dc10e9793ce3ed9d85bb4adcd2740dc9b951b14cf69b38e687 |
|
| MD5 | 17d70781d54d83ab365bf4695279c776 |
|
| BLAKE2b-256 | cc99c21448689d993ae94c684ff912e5c374e69571dfb2dbc01703bcb5f16d32 |
File details
Details for the file deepmodeling_sphinx-0.2.4-py3-none-any.whl.
File metadata
- Download URL: deepmodeling_sphinx-0.2.4-py3-none-any.whl
- Upload date:
- Size: 17.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1c4f82d133d929e2196575ed664ff88df62f7fd9280a44a9e62541729bd8243e |
|
| MD5 | 29cb6bcdd8c7a6487b408ed45c40b014 |
|
| BLAKE2b-256 | 3ad17dd18254a4b5333a3e58192ce2b05642ba81e121f6137caac44c736cc412 |
