Skip to main content

Sphinx awesome theme

MIT license PyPI version

Create beautiful and awesome documentation websites with Sphinx. See how the theme looks like on sphinxawesome.xyz.

Get started

  1. Install the theme as a Python package:

    pip install sphinxawesome-theme
    

    For more information, see Install the theme.

  2. Add sphinxawesome_theme as an HTML theme in your Sphinx configuration file conf.py:

    html_theme = "sphinxawesome_theme"
    

    For more information, see Add your theme.

Features

With the Awesome Theme, you can build readable, functional, and beautiful documentation websites.

Awesome code blocks

  • Code block have a Copy button for copying the code.

  • You can use these additional options in code-block directives:

    • emphasize-added. Highlight lines that should be added
    • emphasize-removed. Highlight lines that should be removed
    • emphasize-text: TEXT. Highlight TEXT in the code block

Clicking the link icon after headers or captions automatically copies the URL to the clipboard.

DocSearch

This theme supports the sphinx-docsearch extension to replace the built-in search with Algolia DocSearch.

Metadata

Release files for sphinxawesome-theme 6.0.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinxawesome-theme 6.0.6
File Size Uploaded Provenance Actions
sphinxawesome_theme-6.0.6.tar.gz 347.6 kB With provenance Details for sphinxawesome_theme-6.0.6.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for sphinxawesome-theme 6.0.6
File Interpreter ABI Platform Actions
sphinxawesome_theme-6.0.6-py3-none-any.whl Python 3 none any Details for sphinxawesome_theme-6.0.6-py3-none-any.whl

Total release size: 728.1 kB

Release files / sphinxawesome_theme-6.0.6.tar.gz

Download URL sphinxawesome_theme-6.0.6.tar.gz
Size 347.6 kB
Tags Source
SHA-256 checksum
How to use checksums
66bced542e96b2f657c3f535247033842a7155db237198d810f5bfc9911d62f1
BLAKE2b-256 checksum
How to use checksums
695349bfe364ea42084bfcc726d16b3dc9bb45cfe813473e55cfbabc6573f3d7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 22, 2026.

Transparency log

Release files / sphinxawesome_theme-6.0.6-py3-none-any.whl

Download URL sphinxawesome_theme-6.0.6-py3-none-any.whl
Size 380.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
58f7ceaa2a8e4216547911d91cfcb4abd8b9ddbd556024d4e606a0d7396e3b9a
BLAKE2b-256 checksum
How to use checksums
0f2da48b81f8dd73da924b70b4d9d03142f13ab515e0f4d637b0384ee9dabae6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 22, 2026.

Transparency log

Security for sphinxawesome-theme 6.0.6

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for sphinxawesome_theme-6.0.6.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 22, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

6.0.6 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page