Qiskit / Qiskit/documentation

Add standard sphinx configuration

Open
#5,637 0 comments 0 reactions 1 assignee View on GitHub

@kaelynj is already working on this.

Since Sep 11, 2026.

content 📄
Dominant language
Jupyter Notebook
Stars
106
Forks
223
Avg merge
1d 8h
Merged PRs (30d)
72

Description

Recently we've begun importing the sphinx documentation of new packages using our gen-addon script. However, not all of the Sphinx artifacts are configured in the same way (different nesting, TOC structure, custom latex macros, etc.) We should add a new readme which goes over expectations for how a package's sphinx artifact should be structured before importing it into a new documentation subsite.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.