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.0.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.0-py3-none-any.whl (18.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: deepmodeling_sphinx-0.4.0.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.0.tar.gz
Algorithm Hash digest
SHA256 7b6e091c8b16cb2dcc5cfb177050edf9f0916b2935cd8e966103bdf0b3bc401c
MD5 fa14a755893490e302ea031004e0d52f
BLAKE2b-256 5236d37aba77e790e39037ab5ad066bbc136571c250ca3119ff708bb57704e91

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for deepmodeling_sphinx-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ffb31b2647ea733802990cd3eb8c0770eca1e19cae56dcd2990cd4c4139a947e
MD5 b2374013802432ef0be862b16944c7d8
BLAKE2b-256 b8e8bdf7e2ef738266696659ec13e46d60bbd86e8098404094c37235b408168f

See more details on using hashes here.

Provenance

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