Skip to main content

Build Status PyPI

sphinx-hackerrank

Build portable Interviewer Guidelines from maintained Sphinx guides.

  • Reuse Sphinx’s HTML renderer.

  • Export one standalone HTML fragment per question and language, plus a local preview index.

  • Build and preview without a HackerRank login or API token.

Installation

  • Requires Python 3.12+ and Sphinx 9.1.1+.

  • Installed packages need no sys.path changes.

Install from PyPI:

pip install sphinx-hackerrank

Or install a wheel from the GitHub release assets:

pip install https://github.com/adamtheturtle/sphinx-hackerrank/releases/download/2026.10.30.2/sphinx_hackerrank-2026.10.30.2-py3-none-any.whl

Enable the extension in conf.py:

"""Sphinx configuration."""

extensions = ["sphinx_hackerrank"]

Authoring

Keep the full guide and its Interviewer Guideline RST beside each other. For guides organized into parts with a Prompt subsection, the Interviewer Guideline can contain just:

.. interviewer-guideline:: widgets.rst

The directive derives its page title from the guide and its languages from the adjacent question mapping. Each part with a direct Prompt subsection gets a disclosure, in source order. The categories use the existing sections:

  • Prompt.

  • FAQ, when present.

  • Signals and edge-case questions, combining Follow up questions and Key considerations.

  • Test cases, when present.

Follow-up sections can be nested beneath Prompt, FAQ, or another section. They appear once in their own category, without requiring parent paths or exclusions in the composition. Empty categories are omitted after admonitions are removed. A guide-level Evaluation section, when present, appears after the parts. Missing mappings, missing parts, and ambiguous category or evaluation headings fail the build. Changing the guide or mapping refreshes the view on an incremental build.

For other layouts, include native sections by exact heading path or an existing RST section label:

.. container:: hr-interviewer-guideline interviewer-guideline-python

   .. collapse:: Prompt

      .. interviewer-guideline-section:: widgets.rst
         :section: Part 1 / Prompt
         :language: python
  • Use :section: #widget-prompt to select a labelled section.

  • Add :include-heading: to retain the selected section’s heading.

  • Nested headings become rubrics inside disclosures.

  • Build with -W to reject missing or ambiguous selections as directive errors.

  • Sections come from the full guide without extraction markers or duplicated content.

  • Native includes, substitutions, and the guide’s existing Jinja templates are supported.

  • Variants are cached within each Interviewer Guideline read and discarded before Sphinx persists the document tree.

  • Guide and included-file dependencies are tracked for incremental builds.

Subsection exclusions

Keep the guide’s existing heading hierarchy when composing separate disclosures. Use :exclude-sections: to omit subsections from a parent selection:

.. interviewer-guideline-section:: widgets.rst
   :section: Part 1 / Prompt
   :language: python
   :exclude-sections: Follow up questions

.. interviewer-guideline-section:: widgets.rst
   :section: Part 1 / Prompt / Follow up questions
   :language: python
  • Exclusions are heading paths relative to the selected section, or section labels within it.

  • List multiple exclusions on separate indented lines.

  • Missing or ambiguous exclusions fail the build, as does excluding the selected section itself.

  • Exclusions affect only the copied view. The source guide and other selections retain their content.

Language contexts

Configure how each language renders the guide’s Jinja context:

"""Sphinx configuration."""

hackerrank_jinja_context = "snippets"
hackerrank_languages = {
    "python": {
        "name": "Python",
        "context": {"variants": [{"name": "Python", "lexer": "python"}]},
    },
}
  • context overrides values in the configured Jinja context while that variant is parsed. The original configuration is restored afterwards.

  • name identifies redundant language disclosures to flatten in copied content.

  • Other part, category, and test-alternative disclosures remain intact.

  • Admonitions are omitted within hr-interviewer-guideline containers by default. Set hackerrank_exclude_admonitions = False to retain them. The full guide’s admonitions are unaffected.

Question mappings

Create a mapping beside each Interviewer Guideline, such as widgets-interviewer-guideline.yml beside widgets-interviewer-guideline.rst:

version: 1
questions:
  - language: python
    name: Widgets - Python
  • hackerrank_manifest_pattern defaults to **/*-interviewer-guideline.yml, relative to Sphinx’s source directory.

  • Nested directories and custom source layouts are supported.

  • The builder reads the language and name. Your publishing tool can manage extra fields such as question IDs.

Build and preview

sphinx-build -W -b hackerrank docs build/hackerrank
  • Open build/hackerrank/interviewer-guidelines/index.html to select a question and language.

  • Each preview uses the same self-contained HTML that can be saved as HackerRank Interviewer Guidelines.

  • Each code block has a keyboard-accessible Copy code button that preserves whitespace.

  • Copy buttons use JavaScript bundled with the output. Hosts must allow that script to run for the buttons to appear.

  • Native disclosure elements and code remain usable without JavaScript.

  • The builder also produces ordinary themed HTML pages. The extension’s directives work in the standard html builder too.

  • Sphinx’s native only directive can select builder_hackerrank, builder_html, or the shared html format tag.

Publishing

  • Use a separate publishing tool to call the HackerRank API and manage credentials, question identities, candidate prompts, or projects.

  • Your publishing tool can read the generated fragments and verify saved Interviewer Guidelines.

Use sphinx_hackerrank.html.html_equivalent to compare generated and saved HTML. It tolerates entity encoding, block indentation, and HackerRank’s column-width formatting. Literal whitespace in code, scripts, styles, and text areas is preserved, as are spaces separating inline elements and disclosure attributes. normalize_html(html=...) exposes the normalized representation when needed. The comparison can be passed as the notes_equal callback to the HackerRank SDK’s questions.update_internal_notes() method.

Contributing

See CONTRIBUTING.rst for setup, linting, tests, and releases.

  • The sample under sample/source uses a custom Jinja context and nested guide files.

  • The wheel smoke test installs the built wheel into a fresh environment and builds that sample outside the checkout.

License

MIT. See LICENSE.

Metadata

Release files for sphinx-hackerrank 2026.10.30.4

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

Source distribution (sdist)

Source distribution for sphinx-hackerrank 2026.10.30.4
File Size Uploaded Provenance Actions
sphinx_hackerrank-2026.10.30.4.tar.gz 193.2 kB With provenance Details for sphinx_hackerrank-2026.10.30.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for sphinx-hackerrank 2026.10.30.4
File Interpreter ABI Platform Actions
sphinx_hackerrank-2026.10.30.4-py3-none-any.whl Python 3 none any Details for sphinx_hackerrank-2026.10.30.4-py3-none-any.whl

Total release size: 214.3 kB

Release files / sphinx_hackerrank-2026.10.30.4.tar.gz

Download URL sphinx_hackerrank-2026.10.30.4.tar.gz
Size 193.2 kB
Tags Source
SHA-256 checksum
How to use checksums
61f54685f1064c0ed4b7a6246ddfb6ae4ece8b4159cf22187f3aaf4e3989de48
BLAKE2b-256 checksum
How to use checksums
d65cbd0e0bad70d3a3e416a638862105348b6994478a60b3a3796ffe1e82dab0
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 30, 2026.

Transparency log

Release files / sphinx_hackerrank-2026.10.30.4-py3-none-any.whl

Download URL sphinx_hackerrank-2026.10.30.4-py3-none-any.whl
Size 21.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
08c0bc26b98b743c8cdddf838e0a9e8ea7ddcd8e93197d482993a47c4d09f807
BLAKE2b-256 checksum
How to use checksums
d17a64152b49984763ab8568099fd614572b2e70eb15039e795c6cba16644498
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 30, 2026.

Transparency log

Security for sphinx-hackerrank 2026.10.30.4

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 sphinx_hackerrank-2026.10.30.4.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 30, 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.

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