You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: guide/7 Documentation/Accessing qiskit-metal documentation.ipynb
+17-23Lines changed: 17 additions & 23 deletions
Original file line number
Diff line number
Diff line change
@@ -4,21 +4,27 @@
4
4
"cell_type": "markdown",
5
5
"metadata": {},
6
6
"source": [
7
-
"# Demo Notebook for Loading Documents"
7
+
"# Preparing and loading the documentation"
8
8
]
9
9
},
10
10
{
11
11
"cell_type": "markdown",
12
12
"metadata": {},
13
13
"source": [
14
-
"## Build the documents"
14
+
"## Build the documentation"
15
15
]
16
16
},
17
17
{
18
18
"cell_type": "markdown",
19
19
"metadata": {},
20
20
"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."
22
28
]
23
29
},
24
30
{
@@ -28,15 +34,17 @@
28
34
"outputs": [],
29
35
"source": [
30
36
"# 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"
33
39
]
34
40
},
35
41
{
36
42
"cell_type": "markdown",
37
43
"metadata": {},
38
44
"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`"
40
48
]
41
49
},
42
50
{
@@ -45,22 +53,8 @@
45
53
"metadata": {},
46
54
"outputs": [],
47
55
"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."
0 commit comments