Skip to main content

Sphinx extension for DeepModeling projects.

Project description

deepmodeling_sphinx

pip install Documentation Status

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


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.3.2.tar.gz (21.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

deepmodeling_sphinx-0.3.2-py3-none-any.whl (17.7 kB view details)

Uploaded Python 3

File details

Details for the file deepmodeling_sphinx-0.3.2.tar.gz.

File metadata

  • Download URL: deepmodeling_sphinx-0.3.2.tar.gz
  • Upload date:
  • Size: 21.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for deepmodeling_sphinx-0.3.2.tar.gz
Algorithm Hash digest
SHA256 91d10b64c69961329c8f6889287aac009aeb2bf3b98b8170fe05d32dc36c5133
MD5 17a96a8de656aa7d7590303e86b95e27
BLAKE2b-256 82ee1d00cf6f31d55bce9b81fe3499d35d6c5fb93aac4851df8942111da6c3ac

See more details on using hashes here.

Provenance

The following attestation bundles were made for deepmodeling_sphinx-0.3.2.tar.gz:

Publisher: release.yml on deepmodeling/deepmodeling_sphinx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file deepmodeling_sphinx-0.3.2-py3-none-any.whl.

File metadata

File hashes

Hashes for deepmodeling_sphinx-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 cb674c9f0635d6b4b85f2a52e0c66c4db4028d283a0efcf2e8b5402735adcfc5
MD5 a3f31277768a15216aed5ba7b21ceef5
BLAKE2b-256 34f431c8416e39179b0a95bcf24a456ecb2e2037ef528dd517294eb6a36d0069

See more details on using hashes here.

Provenance

The following attestation bundles were made for deepmodeling_sphinx-0.3.2-py3-none-any.whl:

Publisher: release.yml on deepmodeling/deepmodeling_sphinx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page