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.7.tar.gz
(20.3 kB
view details)
Built Distribution
File details
Details for the file deepmodeling_sphinx-0.2.7.tar.gz.
File metadata
- Download URL: deepmodeling_sphinx-0.2.7.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 | 3a4c73fd860f674749f4e3b76e39c03a47c6cc5cb0774cac05ab06fa79a50d46 |
|
| MD5 | d3a77cab3668385f4ac9c9e75d526c9d |
|
| BLAKE2b-256 | 5f9fd89e52885b4b721afa43ab1a29b04f4d370e9496fc198e2d9e117d1b2153 |
File details
Details for the file deepmodeling_sphinx-0.2.7-py3-none-any.whl.
File metadata
- Download URL: deepmodeling_sphinx-0.2.7-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 | 25fe5f2fc54eb868e0d03fece2494c6407f5fa35c311f25d065bac085645f8e5 |
|
| MD5 | 1fe5081918e73b9286b4a329a050fd16 |
|
| BLAKE2b-256 | e95ee91a9910204cac744de64272c7679b8c78c2b03ac064740ed2a0e3185004 |
