https://github.com/deepmodeling/deepmodeling_sphinx

Sphinx extension for DeepModeling projects
https://github.com/deepmodeling/deepmodeling_sphinx

python sphinx

Last synced: 6 days ago
JSON representation

Sphinx extension for DeepModeling projects

• Host: GitHub
• URL: https://github.com/deepmodeling/deepmodeling_sphinx
• Owner: deepmodeling
• License: lgpl-3.0
• Created: 2022-03-04T00:19:06.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-10-27T22:37:32.000Z (7 days ago)
• Last Synced: 2024-10-28T13:45:40.581Z (6 days ago)
• Topics: python, sphinx
• Language: CSS
• Homepage: https://docs.deepmodeling.com/projects/deepmodeling-sphinx/
• Size: 83 KB
• Stars: 3
• Watchers: 5
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• deepmodeling-projects - GitHub

README

        
# deepmodeling_sphinx

[![pip install](https://img.shields.io/pypi/dm/deepmodeling_sphinx?label=pip%20install&logo=pypi)](https://pypi.org/project/deepmodeling_sphinx)

[![Documentation Status](https://readthedocs.org/projects/deepmodeling-sphinx/badge/)](https://deepmodeling-sphinx.readthedocs.io/)

This package should be used in all sphinx projects under the [@deepmodeling](https://github.com/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`:

```py

extensions = [

    'deepmodeling_sphinx',

]

```

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

```py

# default: True

enable_deepmodeling = False

```

### Render list of authors

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

```rst

.. git-shortlog-authors::

```