Skip to main content

An awesome theme for the Sphinx documentation generator

Project description

Sphinx awesome theme

MIT license PyPI version Netlify Deploy GitHub Workflow Status

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

Better headerlinks

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.

Project details


Release history Release notifications | RSS feed

This version

5.3.2

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinxawesome_theme-5.3.2.tar.gz (364.0 kB view details)

Uploaded Source

Built Distribution

sphinxawesome_theme-5.3.2-py3-none-any.whl (375.2 kB view details)

Uploaded Python 3

File details

Details for the file sphinxawesome_theme-5.3.2.tar.gz.

File metadata

  • Download URL: sphinxawesome_theme-5.3.2.tar.gz
  • Upload date:
  • Size: 364.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.13.0 Linux/6.5.0-1025-azure

File hashes

Hashes for sphinxawesome_theme-5.3.2.tar.gz
Algorithm Hash digest
SHA256 0629d38b80aefc279b1186c53a7a6faf21e721b5b2ecda14f488ca1074e2631f
MD5 d48bcb0673f6c305a5076662bcaa3ff7
BLAKE2b-256 45586f3e05f77c881e1356d73fc1d99561efe1795671bd56e7fb47c63a32cc1f

See more details on using hashes here.

File details

Details for the file sphinxawesome_theme-5.3.2-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinxawesome_theme-5.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5f2bb6b6ab8fa11db1ded5590106eb557351d6a6c36adea7ebd4e0f4bc96945d
MD5 09488655235bbf3e27227bfd7070ac75
BLAKE2b-256 9be9ca6a7178677bb171c8fd7f9eab726c00182168d38a79d2a58e7678590227

See more details on using hashes here.

Supported by

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