Create beautiful and awesome documentation websites with Sphinx. See how the theme looks like on sphinxawesome.xyz.
Install the theme as a Python package:
pip install sphinxawesome-theme
For more information, see Install the theme.
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.
With the Awesome Theme, you can build readable, functional, and beautiful documentation websites.
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 addedemphasize-removed. Highlight lines that should be removedemphasize-text: TEXT. Highlight TEXT in the code blockClicking the link icon after headers or captions automatically copies the URL to the clipboard.
This theme supports the sphinx-docsearch extension
to replace the built-in search with Algolia DocSearch.
FAQs
An awesome theme for the Sphinx documentation generator
We found that sphinxawesome-theme demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Critics call the Node.js EOL CVE a misuse of the system, sparking debate over CVE standards and the growing noise in vulnerability databases.
Security News
cURL and Go security teams are publicly rejecting CVSS as flawed for assessing vulnerabilities and are calling for more accurate, context-aware approaches.
Security News
Bun 1.2 enhances its JavaScript runtime with 90% Node.js compatibility, built-in S3 and Postgres support, HTML Imports, and faster, cloud-first performance.