sphinx-hackerrank
Export Sphinx documentation as self-contained HTML for HackerRank Interviewer Guidelines, with styles and images. Build and preview locally without HackerRank credentials.
Quick start
In an existing Sphinx project:
pip install sphinx-hackerrank
Add this to docs/conf.py (replace docs with your Sphinx source directory):
"""Sphinx configuration."""
from sphinx_hackerrank import GuidelineExport
extensions = ["sphinx_hackerrank"]
hackerrank_exports = [
GuidelineExport(
docname="review",
selector=".hr-interviewer-guideline",
output_path="interviewer-guidelines/review.html",
name="Widget review",
),
]
Create docs/review.rst and add review to your existing toctree:
Widget review
=============
.. container:: hr-interviewer-guideline
Interviewer instructions go here.
.. code-block:: text
example input
Build:
sphinx-build -W -b hackerrank docs build/hackerrank
Open build/hackerrank/interviewer-guidelines/index.html to preview the exports. Upload build/hackerrank/interviewer-guidelines/review.html using your own publishing tool.
Choosing content
Each GuidelineExport specifies:
docname: the RST path relative to your source directory, without .rst.
selector: a CSS selector matching exactly one container in that page.
output_path: a unique HTML path relative to the build directory.
name: the label shown in the preview index.
Use the hr-interviewer-guideline container class for bundled styles. The builder also produces ordinary themed documentation pages.
For collapsible sections, enable sphinx-toolbox.collapse. To reuse guide sections, enable sphinx-section-include. See the sample project for both.
Source links
Links to other pages point to the local build by default. To link to hosted documentation, set hackerrank_source_url = "https://example.org/guides/" in conf.py. For source files, set hackerrank_source_suffix = ".rst" too. Set hackerrank_source_anchors = False if the destination does not support anchors.
Contributing
See CONTRIBUTING.rst for checks and releases. MIT licensed.
Metadata
Release files for sphinx-hackerrank 2026.11.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sphinx_hackerrank-2026.11.3.tar.gz | 171.0 kB | With provenance | Details for sphinx_hackerrank-2026.11.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sphinx_hackerrank-2026.11.3-py3-none-any.whl | Python 3 | none | any | Details for sphinx_hackerrank-2026.11.3-py3-none-any.whl |
Total release size: 181.4 kB
Release files / sphinx_hackerrank-2026.11.3.tar.gz
| Download URL | sphinx_hackerrank-2026.11.3.tar.gz |
|---|---|
| Size | 171.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
be1654f703a322adaf414f0eb933c63c221d472783700991cd8442badc5f0f39
|
|
BLAKE2b-256 checksum How to use checksums |
345e29f504e7c53f744f562d8944ccae16fad55e3be2d89a8b65a2c015e42dc6
|
| 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 Nov 3, 2026.
Transparency logRelease files / sphinx_hackerrank-2026.11.3-py3-none-any.whl
| Download URL | sphinx_hackerrank-2026.11.3-py3-none-any.whl |
|---|---|
| Size | 10.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c47eb3cf9751b3e3dcb386a7e5753c8f1e4cabd9bdd74313a3b2de8d9da13d09
|
|
BLAKE2b-256 checksum How to use checksums |
8a384668a2a948081f88b524b2efd9408dff725ebca9d6c958b88029a36a5134
|
| 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 Nov 3, 2026.
Transparency logSecurity for sphinx-hackerrank 2026.11.3
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.
Attestation for sphinx_hackerrank-2026.11.3.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 Nov 3, 2026.
Transparency logA 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.