################################# Welcome to Qiskit Docs Guide v1.0 ################################# Overview ======== The intent of the Qiskit docs guide is to help Qiskit maintainers improve their documentation and to provide recommendations for good practices for all Qiskit projects. In this guide, you can find an introduction to creating a Qiskit documentation project with :doc:`Sphinx ` and `Diátaxis `_, the documentation framework we are using in Qiskit, as well as some practical guides for Sphinx-related tasks and, finally, guidelines and examples for the pages that make up Qiskit's standard sidebar. .. toctree:: :caption: Introduction :hidden: Start Here intro/how_to_use_this_guide intro/diataxis intro/new_doc_project sphinx_guide/index .. toctree:: :caption: Instructions for Standard Pages :hidden: home getting_started tutorials/index how_to/index apidocs/index explanations/index release_notes GitHub Next steps ========== :ref:`how-to-use-this-guide`