add existing guidelines #154
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Dec 21, 2022
Guillermo-Mijares-Vilarino
added a commit
that referenced
this pull request
Feb 27, 2023
* Revert docs guidelines (#107) (#109) * Revert "Change qiskit-x to index in docs_guidelines/index (#99)" This reverts commit 1653888. * Revert "Sphinx project for doc guidelines (#78)" This reverts commit 23cd1f8. * Feature/docs guidelines/new sphinx project (#108) * create a brand new sphinx project * use qiskit sphinx theme * remove _build files * ignore docs_guidelines/_build/ folder * change homepage title * add placeholder for each types of content * add placeholder for each types of content * add overview * correct Guillermo name * rename apidoc index page * Revert "Revert docs guidelines (#107) (#109)" This reverts commit eb9b840. * Add workflow to build and deploy docs guidelines to github pages (#148) * Add workflow for building and deploying docs guidelines on github pages (#147) * add github workflow for deploying github pages * install the theme in editable mode * modify workflow file * fix workflow file * fix workflow file * pip tox<4.0.0 * change to deploy docs_guidelines * add _static folder * use github official workflows * modify workflow file * Revert "modify workflow file" This reverts commit e4f13c1. * Revert "use github official workflows" This reverts commit 0fb40c9. * bypass jekyll processing * modify workflow file * use python 3.9 * modify workflow file * modify workflow file * comment out push branches for testing * add name for job * remove files in _static folder * enable running workflow in PR for temporary testing * add gallery.css to _static path. The folder is necessary for successful building * remove pico-8 files that were accidentally added * remove trigger on pull request and specify push trigger to docs-guidelines branch * remove static path * add comments for html_static_path * remove html_static_path * add link to readme * Added explanations (#130) * Added explanation about Diataxis and why we use it * added explanation about sphinx and why we use it in Qiskit * Added explanation about what's rst why we use it * Addressed review comments * Add tutorial about creating a new Sphinx project for a Qiskit package (#115) * create a brand new sphinx project * use qiskit sphinx theme * remove _build files * ignore docs_guidelines/_build/ folder * change homepage title * add placeholder for each types of content * add placeholder for each types of content * add overview * correct Guillermo name * added tutorial about creating a new Sphinx project * Delete qiskit_x.rst * added how to deploy docs * Added links and made small fixes * changed sphinx-quickstart cells from bash to text * removed mention to copyright * changed tutorial index so that the title is automatically taken from the tutorial * updated intro paragraph * Adressed review comments * Added example image of locally built page Co-authored-by: Junye Huang <h.jun.ye@gmail.com> * Added how-tos (#98) * Added how-tos and sphinx extensions * Update how_to/index.rst * Updated docs_guidelines/index.rst to change qiskit_x to index * restructured index and added sections how-to * Added how to create a list guide * Added how to build docs locally guide * Added how to add an API reference guide * Added how to add a tutorial and how to add an explanation * Fixed typo * fix typos * Addressed review comments * Fixed backquotes * Removed must and have to and added pre-requisites * Addressed review comments * changed copyright * Update docs_guidelines/conf.py Co-authored-by: Luciano Bello <bel@zurich.ibm.com> Co-authored-by: Junye Huang <h.jun.ye@gmail.com> * Add docs guide test (#152) * add workflow for build and test docs guidelines for PR * set target branch as docs guide * rename test * add sphinx-autodoc-typehints to requirements (#153) * add sphinx-autodoc-typehints to requirements * comment out add an API reference * remove how to add a API reference * remove add code and crossreference how-to guides * remove apidocs from terra * remove apidocs from terra * fix how to guide referencing error * fix how to guide referencing error * Docs guidelines/add existing examples (#135) * add api reference placeholders * remove links to guidelines and templates * add qiskit ibm runtime tutorials examples * add how-to guide examples * use list in tutorials examples * add api examples * add existing guidelines (#154) * add existing guidelines * add guidelines to index * Add terra to docs_guidelines tests * Update tox.ini * Added pylatexenc to docs-guide env * remove terra * Fix removed how-tos (#157) * Added how-tos and sphinx extensions * Update how_to/index.rst * Updated docs_guidelines/index.rst to change qiskit_x to index * restructured index and added sections how-to * Added how to create a list guide * Added how to build docs locally guide * Added how to add an API reference guide * Added how to add a tutorial and how to add an explanation * Fixed typo * fix typos * Addressed review comments * Fixed backquotes * Removed must and have to and added pre-requisites * Addressed review comments * changed copyright * Update docs_guidelines/conf.py * Fixed guides * Added terra to docs_guidelines test and deployment * Add terra to docs_guidelines tests * Update tox.ini * Add pylatexenc to docs-guide env * Remove terra * added requirements-extra.txt * removed python numpy and scipy from intersphinx * added testcode testoutput and testsetup and how to run doctests * Added sphinx to intersphinx mapping and updated links * Added interspinx section and changed links * Add requirements-extra explanation Co-authored-by: Junye Huang <h.jun.ye@gmail.com> * Update tox.ini Co-authored-by: Junye Huang <h.jun.ye@gmail.com> * Update tox.ini * Improve links Co-authored-by: Luciano Bello <bel@zurich.ibm.com> Co-authored-by: Junye Huang <h.jun.ye@gmail.com> * Add doctest to docs guide test workflow and deploy workflow (#159) * Added how-tos and sphinx extensions * Update how_to/index.rst * Updated docs_guidelines/index.rst to change qiskit_x to index * restructured index and added sections how-to * Added how to create a list guide * Added how to build docs locally guide * Added how to add an API reference guide * Added how to add a tutorial and how to add an explanation * Fixed typo * fix typos * Addressed review comments * Fixed backquotes * Removed must and have to and added pre-requisites * Addressed review comments * changed copyright * Update docs_guidelines/conf.py * Fixed guides * Added terra to docs_guidelines test and deployment * Add terra to docs_guidelines tests * Update tox.ini * Add pylatexenc to docs-guide env * Remove terra * added requirements-extra.txt * removed python numpy and scipy from intersphinx * added testcode testoutput and testsetup and how to run doctests * Added sphinx to intersphinx mapping and updated links * doctest to workflows * check if failed test triggers error * Revert "check if failed test triggers error" This reverts commit 7f1dae2. * remove python depencies installations because tox installs it already * remove python depencies installations in docs-guide-deploy * Undo unintended changes in crossreference.rst * fix tox path * change doctest workflow output path to doctest folder Co-authored-by: Guillermo Mijares Vilarino <Guillermo.Mijares.Vilarino@ibm.com> Co-authored-by: Guillermo-Mijares-Vilarino <106545082+Guillermo-Mijares-Vilarino@users.noreply.github.com> Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * Restructure docs guide (#166) * move tutorials related pages under tutorials folder * move how-to related pages under how-to folder * move explanations related pages under explanations folder * move api related pages under api folder * move sphinx related content to a new sphinx_guide folder * add a frontmatter section * rename files * rename files and sections based on Abby comments * add notes for pages that do not have instructions yet * use direct link in toctree without text title * rename overview_guide to overview * rename frontmatter folder to intro * add version for docs guide * rename docs_guidelines to docs_guide * rename docs_guidelines to docs_guide everywhere * rename sphinx project name to Qiskit Docs Guide and modify copyright years * add notes about documentation types in each page * add descriptions for examples pages * use include directive to reuse doc type notes and under construction notes * add templates placeholders * add - to crossreference * fix tox path * fix tox path * use intersphinx to link api examples * use intersphinx to link how-to guides and tutorials examples in qiskit-ibm-runtime * add "how to" in file names and titles of how to guides * Combine general pre-requisites * Use general pre-requisites * Unify intersphinx syntax * move diataxis image position * rename individual pages to standard pages * add explanation type note to rst.rst * move recommended folder structure to create new doc tutorial * update the phrasing of doc type notes * Add intro pages (#170) * Add overview and how to use this guide and improve links * change link Co-authored-by: Junye Huang <h.jun.ye@gmail.com> * change sphinx-build link Co-authored-by: Junye Huang <h.jun.ye@gmail.com> * simplify link Co-authored-by: Junye Huang <h.jun.ye@gmail.com> * Shorten link Co-authored-by: Junye Huang <h.jun.ye@gmail.com> * fixed typos * State intention of the guide before explaining its content Co-authored-by: Junye Huang <h.jun.ye@gmail.com> * changed = to # for titles * rephrase slightly Co-authored-by: Junye Huang <h.jun.ye@gmail.com> * rephrased last paragraph of how to use this guide * added contributing to this guide section * Update docs_guide/getting_started.rst change getting started label Co-authored-by: Junye Huang <h.jun.ye@gmail.com> * Change release notes label Co-authored-by: Junye Huang <h.jun.ye@gmail.com> * Change how to label Co-authored-by: Junye Huang <h.jun.ye@gmail.com> * change how-to reference Co-authored-by: Junye Huang <h.jun.ye@gmail.com> * change getting-started an release-notes references Co-authored-by: Junye Huang <h.jun.ye@gmail.com> * change how to use this guide label Co-authored-by: Junye Huang <h.jun.ye@gmail.com> * change how to use this guide reference Co-authored-by: Junye Huang <h.jun.ye@gmail.com> * change sphinx guide label Co-authored-by: Junye Huang <h.jun.ye@gmail.com> * change sphinx-guide reference * fix contributing to this guide section * fix link * fixed folder name Co-authored-by: Junye Huang <h.jun.ye@gmail.com> * change docs guide workflows target branch to main * add overview section to describe the purposes of the theme, sample docs and docs guide * Update docs_guide/intro/how_to_use_this_guide.rst Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * Update docs_guide/intro/how_to_use_this_guide.rst Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * Update docs_guide/intro/how_to_use_this_guide.rst Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * Update docs_guide/intro/how_to_use_this_guide.rst Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * Update docs_guide/intro/how_to_use_this_guide.rst Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * Update docs_guide/intro/how_to_use_this_guide.rst Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * Update docs_guide/intro/diataxis.rst Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * Update docs_guide/explanations/how_to_add_an_explanation.rst Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * Update docs_guide/explanations/how_to_add_an_explanation.rst Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * Update docs_guide/overview.rst Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * rename overview to documentation home * Update README.md Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * fix readme links to folders * Update docs_guide/intro/new_doc_project.rst Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * Update docs_guide/intro/new_doc_project.rst Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * Update docs_guide/intro/new_doc_project.rst Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * Update docs_guide/intro/new_doc_project.rst Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * Update docs_guide/intro/new_doc_project.rst Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * Update docs_guide/intro/new_doc_project.rst Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * Update docs_guide/intro/new_doc_project.rst Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * Update docs_guide/intro/new_doc_project.rst Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * Update docs_guide/intro/new_doc_project.rst Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * Update docs_guide/sphinx_guide/rst.rst Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * Update docs_guide/sphinx_guide/sphinx.rst Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * Update docs_guide/sphinx_guide/how_to_build_docs.rst Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * Update docs_guide/others/general_pre-requisites.rst Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * Update docs_guide/tutorials/index.rst Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * Update docs_guide/tutorials/how_to_add_a_tutorial.rst Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * Update docs_guide/how_to/index.rst Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * Update docs_guide/how_to/how_to_add_a_how_to_guide.rst Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * Update docs_guide/how_to/how_to_add_a_how_to_guide.rst Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * Update docs_guide/apidocs/index.rst Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * Update docs_guide/explanations/index.rst Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * Update docs_guide/sphinx_guide/index.rst Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * fix build error * add Abby suggestion to why we use Diataxis Co-authored-by: Abby Mitchell <javabster@users.noreply.github.com> * Update docs_guide/apidocs/how_to_add_an_api_reference.rst Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * replace "when" with "whether" Co-authored-by: Abby Mitchell <javabster@users.noreply.github.com> * adapt new doc project tutorial to qiskit ecosystem * remove figure scaling * change Overview to Documentation Home * use 3 spaces indent for toctree * remove = below sentence * address Guillermo review comments * add Eric suggestions * add examples for class and methods doc strings from google python style guide * add link to api doc * Update docs_guide/sphinx_guide/how_to_add_code.rst Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> * Update docs_guide/apidocs/how_to_add_an_api_reference.rst Co-authored-by: Guillermo-Mijares-Vilarino <106545082+Guillermo-Mijares-Vilarino@users.noreply.github.com> * make how to guide more suitable for qiskit ecosystem * simplify how to add sections * Update docs_guide/sphinx_guide/how_to_add_sections.rst Co-authored-by: Guillermo-Mijares-Vilarino <106545082+Guillermo-Mijares-Vilarino@users.noreply.github.com> --------- Co-authored-by: Guillermo-Mijares-Vilarino <106545082+Guillermo-Mijares-Vilarino@users.noreply.github.com> Co-authored-by: Luciano Bello <bel@zurich.ibm.com> Co-authored-by: Guillermo Mijares Vilarino <Guillermo.Mijares.Vilarino@ibm.com> Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> Co-authored-by: Abby Mitchell <javabster@users.noreply.github.com> Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.