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.6.tar.gz
(20.3 kB
view hashes)
Built Distribution
Close
Hashes for deepmodeling_sphinx-0.2.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc6289b6927f52dbb82c1339a1edcb62c304e6ba3be8dde4a58a6a87aaf67917 |
|
MD5 | 2cfc7e097d0abbfdd5c0739f99662293 |
|
BLAKE2b-256 | a158108cdfdba59f5b6c8c97198903c1a49163d3769205bf2b4e894b27369daf |
Close
Hashes for deepmodeling_sphinx-0.2.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 70d45fd5aa395f1334b9d82ba68875c29a7b6c7ea7c379c919db0accb53ab9d1 |
|
MD5 | 57804cdd1fd0c724e812863345a7c892 |
|
BLAKE2b-256 | b9e7d73940aa0907400d60006ac74354605361da027346712c922b060c165b75 |