Skip to content

Commit c420051

Browse files
committed
Detailed the documentation supporting notebook
1 parent 617b6c2 commit c420051

File tree

1 file changed

+17
-23
lines changed

1 file changed

+17
-23
lines changed

guide/7 Loading Documents/Loading Documents.ipynb renamed to guide/7 Documentation/Accessing qiskit-metal documentation.ipynb

Lines changed: 17 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,27 @@
44
"cell_type": "markdown",
55
"metadata": {},
66
"source": [
7-
"# Demo Notebook for Loading Documents"
7+
"# Preparing and loading the documentation"
88
]
99
},
1010
{
1111
"cell_type": "markdown",
1212
"metadata": {},
1313
"source": [
14-
"## Build the documents"
14+
"## Build the documentation"
1515
]
1616
},
1717
{
1818
"cell_type": "markdown",
1919
"metadata": {},
2020
"source": [
21-
"The \"build_docs.py\" script will build the documents for you, all you have to do is execute it. This can be done either on the command line with a simple call to \"python path/build_docs.py\" or from ipython."
21+
"During early-access, we will distribute the source files to build the qiskit-metal documentation locally.\n",
22+
"\n",
23+
"We also provide the `build_docs.py` script to automate the build process. You can easily execute it either on the command line with call: `python path/build_docs.py` or by executing the following cell.\n",
24+
"\n",
25+
"#### Please be patient. The build can take ~15minutes.\n",
26+
"\n",
27+
"the proces will first install key python libraries needed for the build. Then it will run the `make html` command to complete the build."
2228
]
2329
},
2430
{
@@ -28,15 +34,17 @@
2834
"outputs": [],
2935
"source": [
3036
"# Execute the build_docs.py script.\n",
31-
"# Replace the path below with the relative path to the build_docs.py script on your computer.\n",
32-
"%run ../../docs/build_docs.py"
37+
"# Replace the path below with the relative path to the build_docs.py script on your computer.\n",
38+
"%run ../../docs/build_docs.py"
3339
]
3440
},
3541
{
3642
"cell_type": "markdown",
3743
"metadata": {},
3844
"source": [
39-
"## Load the documents with ipython"
45+
"#### You can now access the documentation with the following command.\n",
46+
"\n",
47+
"You can also directly open: `../../docs/build/html/index.html`"
4048
]
4149
},
4250
{
@@ -45,22 +53,8 @@
4553
"metadata": {},
4654
"outputs": [],
4755
"source": [
48-
"from qiskit_metal import open_docs\n",
49-
"open_docs()"
50-
]
51-
},
52-
{
53-
"cell_type": "markdown",
54-
"metadata": {},
55-
"source": [
56-
"## Load the documents with the GUI"
57-
]
58-
},
59-
{
60-
"cell_type": "markdown",
61-
"metadata": {},
62-
"source": [
63-
"At the moment there is no way to load the docs with the metal GUI."
56+
"from qiskit_metal import open_docs\n",
57+
"open_docs()"
6458
]
6559
}
6660
],
@@ -85,4 +79,4 @@
8579
},
8680
"nbformat": 4,
8781
"nbformat_minor": 4
88-
}
82+
}

0 commit comments

Comments
 (0)