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.4.1.tar.gz (21.9 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.4.1-py3-none-any.whl (18.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for deepmodeling_sphinx-0.4.1.tar.gz
Algorithm Hash digest
SHA256 1d5bd6a71e0c560f9dda5c2659e176f26d3f403551fd74d641832e3394104d26
MD5 e6ff49af9116ffd6c774420fb419250d
BLAKE2b-256 8da5a2f01ff15a73d21d63fc4401f311e85b25e81ff543ba24d408623dc80f67

See more details on using hashes here.

Provenance

The following attestation bundles were made for deepmodeling_sphinx-0.4.1.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.4.1-py3-none-any.whl.

File metadata

File hashes

Hashes for deepmodeling_sphinx-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9ebdb37f35f0ea7809e354491b0a234c758b67caf0a7225dc85dcc997421df35
MD5 f1fcc77cf673b0d27b173937b858be9b
BLAKE2b-256 7dba319a9744ddd4ff3957bb0be4d00e281eff3ceef5826c7887693a7aa08b66

See more details on using hashes here.

Provenance

The following attestation bundles were made for deepmodeling_sphinx-0.4.1-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