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.8.tar.gz
(20.3 kB
view details)
Built Distribution
File details
Details for the file deepmodeling_sphinx-0.2.8.tar.gz.
File metadata
- Download URL: deepmodeling_sphinx-0.2.8.tar.gz
- Upload date:
- Size: 20.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ddd927abc166e3f521c1b6afe28149eb5a4fbd75ce9544923dfef33c7b0351ce |
|
| MD5 | 6f3543da39302a67860475e3235e4519 |
|
| BLAKE2b-256 | 2368b1a44b8300c3c9c8b7b768967b7556b2f72a92ab65975984da9060ad8a83 |
File details
Details for the file deepmodeling_sphinx-0.2.8-py3-none-any.whl.
File metadata
- Download URL: deepmodeling_sphinx-0.2.8-py3-none-any.whl
- Upload date:
- Size: 17.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 041564da50107eee0d403113b799bcdbf07ae124066d10a1d6fb18ba879ed39c |
|
| MD5 | 56b7e1da528553e47ccc16ad8225eb5f |
|
| BLAKE2b-256 | 77ab6d245d30f25afa30ff8b8c51ad8400e3c7315138c35a50fdd9cd8f1994b6 |
