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.3.tar.gz
(19.3 kB
view hashes)
Built Distribution
Close
Hashes for deepmodeling_sphinx-0.2.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 86d775e0a978ee61d994bb4a73b14e027def9e0c6c776f323c912b48bae711f5 |
|
MD5 | 02e09c02db2e253a08c738378afad3df |
|
BLAKE2b-256 | 9b5487472793c85c010d0e22e9e30dacf77fd7403aae3dc5065524d320b1041f |
Close
Hashes for deepmodeling_sphinx-0.2.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0eb7a5671134fa36fb5a0f0b5ab8f4cac36b963ebdea03792464d4801c89369d |
|
MD5 | 2a08f25fbc99ffbfd42ee13b5b3d0a24 |
|
BLAKE2b-256 | b3d6189c3fb869a3817f65f4504bab64c6c06e25dbcbacb4314e20cb9eb9e7ad |