Commit Graph

729 Commits

Author SHA1 Message Date
Ali Javadi-Abhari ac6ec753c4 fix broken link in getting started (Qiskit/qiskit-metapackage#465)
* Update getting_started.rst

* Update getting_started.rst
2019-08-20 11:18:43 -04:00
Soolu Thomas 962e830fcd Cleanup old referencing labels from docs (Qiskit/qiskit-metapackage#456)
* Clean up old references

* Removed Label

* Replaced long nb links with apidoc links
2019-08-19 21:13:33 -04:00
Soolu Thomas a450d138f9 Cleanup old referencing labels from docs (Qiskit/qiskit-metapackage#455)
* Clean up old references

* Removed Label
2019-08-19 14:11:40 -04:00
Paul Nation 207266cd20 Another shot at Terra docs (Qiskit/qiskit-metapackage#447)
* partial API cleanup

* remove autosum

* updates

* updates

* updates

* update make doc

* fix links

* do not do api

* text edits

* Update docs/contributing_to_qiskit.rst

Co-Authored-By: Matthew Treinish <mtreinish@kortar.org>

* remove 0.12 modules

* Update docs/conf.py

Co-Authored-By: Matthew Treinish <mtreinish@kortar.org>
2019-08-19 12:28:25 -04:00
Jay M. Gambetta b4071c8d7d Update getting_started.rst 2019-08-18 19:30:36 -04:00
Jay M. Gambetta f9b633cc5f Update getting_started.rst (Qiskit/qiskit-metapackage#441)
* Update getting_started.rst

* Update getting_started.rst
2019-08-18 16:40:18 -04:00
Jay M. Gambetta a34bd2e179 Update faq.rst (Qiskit/qiskit-metapackage#428) 2019-08-18 11:39:56 -04:00
Jay M. Gambetta 35ccc21b4b Update getting_started.rst 2019-08-18 10:55:58 -04:00
Jay M. Gambetta f7c820b72c Update getting_started.rst (Qiskit/qiskit-metapackage#418)
* Update getting_started.rst

* Update getting_started.rst

* Update getting_started.rst

* Update getting_started.rst

* Update getting_started.rst

* grr limiting on the web editor is not fun

* Update getting_started.rst

* minor code styling
2019-08-18 08:50:54 -04:00
Soolu Thomas 2d54043ec6 Standardizing documentation for easier and better translation (Qiskit/qiskit-metapackage#403)
* Removed explicit title from the main index.rst

* Removed explicit titles from the terra TOCs

* Removed explicit titles from the ignis TOCs

* Removed explicit titles from the Aer TOCs

* Removed explicit titles from the Qiskit Chemistry TOCs

* Removed explicit titles from the Aqua TOCs

* Standardize cross reference links

* Standardize hyperlinks issue#390

* fixed typos
2019-08-14 15:42:05 -04:00
Soolu Thomas 6c37ecda56 Standardize the links in .rst files (Qiskit/qiskit-metapackage#391)
* Standardized hyperlinks and underscores

* Fixed lint errors
2019-07-31 19:38:50 -04:00
Soolu Thomas eafb315cab Standardize the links in .rst files (Qiskit/qiskit-metapackage#391)
* Standardized hyperlinks and underscores

* Fixed lint errors
2019-07-31 19:38:50 -04:00
Laura Zdanski 594b5adb59 0.11 IBMQ Provider Doc updates (Qiskit/qiskit-metapackage#367)
* Update install docs

* Load.account() updates

* Update get.backend

* Add update link

* Fix link

* Fix typos

* Address review comments

* Fix line length
2019-07-16 12:08:51 -04:00
Paul Kassebaum fe37b3783f fix getting started (Qiskit/qiskit-metapackage#321)
* closes Qiskit/qiskit-metapackage#319 
make histograms and print statements agree

* Update getting_started.rst

remove merge markers
2019-06-10 14:53:32 -04:00
RohitMidha23 5652b98c91 Fix for issue Qiskit/qiskit-metapackage#319 (Qiskit/qiskit-metapackage#320) 2019-06-10 14:26:47 -04:00
Jay M. Gambetta a1d2fb3001 Update getting_started.rst (Qiskit/qiskit-metapackage#289) 2019-05-23 10:37:15 -04:00
Soolu Thomas e916155644 hone getting started (Qiskit/qiskit-metapackage#279)
* Updated Getting Started

* Removed trailing whitespaces and long lines

* Removed typo

* eliminated build  warnings

* eliminated build  warnings in getting started

* edit getting_started

* edit executing quantum programs

* Update executing_quantum_programs.rst

line length

* fix code block formatting

* fix circuit drawings

* fix plain text code block syntax

* update IBM Q Experience link
2019-05-21 10:40:44 -04:00
Soolu Thomas f66d2dccc4 hone getting started (Qiskit/qiskit-metapackage#279)
* Updated Getting Started

* Removed trailing whitespaces and long lines

* Removed typo

* eliminated build  warnings

* eliminated build  warnings in getting started

* edit getting_started

* edit executing quantum programs

* Update executing_quantum_programs.rst

line length

* fix code block formatting

* fix circuit drawings

* fix plain text code block syntax

* update IBM Q Experience link
2019-05-21 10:40:44 -04:00
Paul Kassebaum d532578590 update Getting Started for Qiskit 0.9 (Qiskit/qiskit-metapackage#248)
* Aqua is now included in `pip install qiskit`. Doesn't need its own pip call.

* update Getting Started for Qiskit 0.9
2019-05-06 18:19:57 -04:00
Paul Kassebaum c8a91a182e Add alt-text to all images in Qiskit docs (Qiskit/qiskit-metapackage#225)
* fixes Qiskit/qiskit-metapackage#196

add alt text to images

* Update docs/terra/plotting_data_in_qiskit.rst

Co-Authored-By: derivation <paul.kassebaum@ibm.com>
2019-05-02 15:18:40 -04:00
Paul Kassebaum 700f9e6343 add FAQ (Qiskit/qiskit-metapackage#219)
* fixes Qiskit/qiskit-metapackage#113

* added link to install instructions

fixed some styles

* Review changes

- Add Q&A Format
2019-05-01 20:44:40 -04:00
Matthew Treinish 1194d9f575 Add doc8 run to CI and lint checks (Qiskit/qiskit-metapackage#52)
* Add doc8 run to CI and lint checks

This commit adds running doc8 to our normal CI and lint workflows. Right
now we don't have any doc verification (aside from what pylint enforces
on docstrings in the tests, which doesn't get published anywhere) and when
it comes time to publish a new release there is a scramble to fix all the
warnings (and potentially errors) in the documentation. By running doc8 we
can verify that our documentation is formatted properly for sphinx to
compile the output without issue (and without any warnings).

* Fix lint issues with aqua docs

* Fix most of the aqua docs lint issues

* Fix last lint issues

* Fix lint from rebase

* More rebase cleanups for new docs

* More rebase fixes
2019-02-21 08:19:19 -05:00
Paul Kassebaum 910171cb3b fixes image reference in getting_started.rst (Qiskit/qiskit-metapackage#130)
* moved Aer tutorial images to /docs/images/figures/

and all references to these images

* Have Makefile point to correct Aqua and Chemistry directories

Fixes Qiskit/qiskit-metapackage#88

* Revert "Have Makefile point to correct Aqua and Chemistry directories"

This reverts commit fee13ba87e1888c88a997430ee0a57969a9985ac.

* Create community_qiskit.rst

* Revert "Create community_qiskit.rst"

This reverts commit 5fd2cafd6d2e570488e9985f26d33a0f5088c581.

* update global install instructions

Motivation: to synthesize the mostly duplicate install instructions currently under each Qiskit element's doc section, which can then be removed.

Direct to CONTRIBUTING files in each element's repo for instructions to build from source, since this serves a niche persona and is lengthy.

Added images for steps that involve pointing and clicking through the web.

Rewrote material for additional clarity.

* removed Troubleshooting section

fixes Qiskit/qiskit-metapackage#97

* simplify the ibm q provider documentation

Fixes Qiskit/qiskit-metapackage#86

* removed Visualizations from global ToC, honed Installing QIskit

Fixes Qiskit/qiskit-metapackage#107 and fixes Qiskit/qiskit-metapackage#95

* added Contributin to Qiskit

fixes Qiskit/qiskit-metapackage#112

* remove Aer install instructions

fixes Qiskit/qiskit-metapackage#84

* Have the ToC do the work, instead of a landing page for Getting Started.

fixes Qiskit/qiskit-metapackage#84

* circuit drawing style in Getting Started

begins to address Qiskit/qiskit-metapackage#98

* adopting the term of art 'quantum cloud services'

* getting_started references wrong circuit drawing PNG file

Fixes Qiskit/qiskit-metapackage#129
2019-02-20 09:39:01 -05:00
Paul Kassebaum 0c376893f6 circuit draw style as mpl in docs/getting_started.rst (Qiskit/qiskit-metapackage#128)
* moved Aer tutorial images to /docs/images/figures/

and all references to these images

* Have Makefile point to correct Aqua and Chemistry directories

Fixes Qiskit/qiskit-metapackage#88

* Revert "Have Makefile point to correct Aqua and Chemistry directories"

This reverts commit fee13ba87e1888c88a997430ee0a57969a9985ac.

* Create community_qiskit.rst

* Revert "Create community_qiskit.rst"

This reverts commit 5fd2cafd6d2e570488e9985f26d33a0f5088c581.

* update global install instructions

Motivation: to synthesize the mostly duplicate install instructions currently under each Qiskit element's doc section, which can then be removed.

Direct to CONTRIBUTING files in each element's repo for instructions to build from source, since this serves a niche persona and is lengthy.

Added images for steps that involve pointing and clicking through the web.

Rewrote material for additional clarity.

* removed Troubleshooting section

fixes Qiskit/qiskit-metapackage#97

* simplify the ibm q provider documentation

Fixes Qiskit/qiskit-metapackage#86

* removed Visualizations from global ToC, honed Installing QIskit

Fixes Qiskit/qiskit-metapackage#107 and fixes Qiskit/qiskit-metapackage#95

* added Contributin to Qiskit

fixes Qiskit/qiskit-metapackage#112

* remove Aer install instructions

fixes Qiskit/qiskit-metapackage#84

* Have the ToC do the work, instead of a landing page for Getting Started.

fixes Qiskit/qiskit-metapackage#84

* circuit drawing style in Getting Started

begins to address Qiskit/qiskit-metapackage#98

* adopting the term of art 'quantum cloud services'
2019-02-20 04:26:47 -05:00
Paul Kassebaum 26723724b8 honed Installing Qiskit, removed Visualizations from global ToC (Qiskit/qiskit-metapackage#114)
* moved Aer tutorial images to /docs/images/figures/

and all references to these images

* Have Makefile point to correct Aqua and Chemistry directories

Fixes Qiskit/qiskit-metapackage#88

* Revert "Have Makefile point to correct Aqua and Chemistry directories"

This reverts commit fee13ba87e1888c88a997430ee0a57969a9985ac.

* Create community_qiskit.rst

* Revert "Create community_qiskit.rst"

This reverts commit 5fd2cafd6d2e570488e9985f26d33a0f5088c581.

* update global install instructions

Motivation: to synthesize the mostly duplicate install instructions currently under each Qiskit element's doc section, which can then be removed.

Direct to CONTRIBUTING files in each element's repo for instructions to build from source, since this serves a niche persona and is lengthy.

Added images for steps that involve pointing and clicking through the web.

Rewrote material for additional clarity.

* removed Troubleshooting section

fixes Qiskit/qiskit-metapackage#97

* simplify the ibm q provider documentation

Fixes Qiskit/qiskit-metapackage#86

* removed Visualizations from global ToC, honed Installing QIskit

Fixes Qiskit/qiskit-metapackage#107 and fixes Qiskit/qiskit-metapackage#95
2019-02-18 10:14:43 -05:00
Jay M. Gambetta 027e7b703c small edits (Qiskit/qiskit-metapackage#109) 2019-02-17 21:51:13 -05:00
Paul Kassebaum 5d6a15bacc simplify the ibm q provider documentation fixes Qiskit/qiskit-metapackage#86 (Qiskit/qiskit-metapackage#105)
* moved Aer tutorial images to /docs/images/figures/

and all references to these images

* Have Makefile point to correct Aqua and Chemistry directories

Fixes Qiskit/qiskit-metapackage#88

* Revert "Have Makefile point to correct Aqua and Chemistry directories"

This reverts commit fee13ba87e1888c88a997430ee0a57969a9985ac.

* Create community_qiskit.rst

* Revert "Create community_qiskit.rst"

This reverts commit 5fd2cafd6d2e570488e9985f26d33a0f5088c581.

* update global install instructions

Motivation: to synthesize the mostly duplicate install instructions currently under each Qiskit element's doc section, which can then be removed.

Direct to CONTRIBUTING files in each element's repo for instructions to build from source, since this serves a niche persona and is lengthy.

Added images for steps that involve pointing and clicking through the web.

Rewrote material for additional clarity.

* removed Troubleshooting section

fixes Qiskit/qiskit-metapackage#97

* simplify the ibm q provider documentation

Fixes Qiskit/qiskit-metapackage#86
2019-02-15 16:36:27 -05:00
Diego M. Rodríguez 3ad655652e Update makefile with autodocs, additional tweaks (Qiskit/qiskit-metapackage#70)
* Documentation fixes

Misc documentation fixes:
* include aqua contributors (copying the file from their repository,
  fixing links).
* remove files not used in the build.
* update images.

* Move images to a single directory

Move the images coming from the jupyter conversions to a single
directory, at `images/figures`, for tidying up the structure (can be
recreated using the `output_files_dir` parameter for nbconvert).

* Update makefile to handle autodoc per project

Update "make autodoc" by depending on three new targets, one for each
project that has a different import path, allowing overriding the
location via environment variables.
Update aqua and chemistry .rst pointing to the autodoc modules.

* Replace code blocks from ipython3 to python

Replace the `.. code:: ipython3` blocks with `.. code:: python` (can
be recreated using `NbConvertBase.default_language` configuration
option).

* Fix makefile phony target
2019-02-07 11:05:35 -05:00
Jay M. Gambetta f26e4b0822 Master (Qiskit/qiskit-metapackage#61)
* Adding documentation

* Fixing documentation.
2019-02-03 16:03:55 -05:00