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::
Project details
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.5.tar.gz
(19.6 kB
view hashes)
Built Distribution
Close
Hashes for deepmodeling_sphinx-0.2.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 85b46d97997389374afb72c2abe0a41d1425857a16e0bf65d36ff322291ec9c7 |
|
MD5 | b241fac046e3550d36cef9442d65f421 |
|
BLAKE2b-256 | 9329fdfd9d29250b85ebedd69391cb212917378f77e07d76b5a44c5a9cf81c7d |
Close
Hashes for deepmodeling_sphinx-0.2.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e0f0113f5973719fa9ff40cd3626248d9d0b4e697664f682d1463a7697851af4 |
|
MD5 | 03bdb1b2d4cbf00bb7a3b00cf6808d2d |
|
BLAKE2b-256 | d9a46b6b40877b0c3268578e410fab9ab659d3688a5b123b0cafce3820e89068 |