deepmodeling_sphinx

This package should be used in the sphinx projects authored by HNECU Group.

Features

• Add the custom banner
• Minify HTML, Javascript, and CSS files
• Supports dark mode for both the banner and the RTD theme

How to use it

Setup

Add hnecu_sphinx to the requirements, as well as the extensions of conf.py:

extensions = [
    'hnecu_sphinx',
]

Projects outside HNECU can also use this extension but disable HNECU specific styles.

# default: True
enable_hnecu = False

Render list of authors

The following directive can be used to render list of authors from git shortlog:

.. git-shortlog-authors::