8000 fix and build new version of doc · sassoftware/sas_kernel@76cf535 · GitHub
[go: up one dir, main page]
Skip to content

Commit 76cf535

Browse files
tomweber-sastomweber-sas
committed
fix and build new version of doc
1 parent 8091f11 commit 76cf535

File tree

1 file changed

+24
-55
lines changed

1 file changed

+24
-55
lines changed

‎sas_kernel/doc/source/install.rst

Lines changed: 24 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Installing the SAS kernel
88

99
The SAS kernel package installs just like any other Python package.
1010
It is a pure Python package and works with Python 3.X
11-
installations. To install using ``pip``, you execute one of the
11+
installations. To install using ``pip``, you execute one of the
1212
following commands.
1313

1414
::
@@ -32,7 +32,7 @@ Linux install for Anaconda Python (assuming SAS already installed)
3232
then use a common location such as ``/opt``.
3333

3434
* One installation prompt is to add the path to your environment. SAS
35-
recommends that you answer 'yes' to the prompt so that you get the
35+
recommends that you answer 'yes' to the prompt so that you get the
3636
executables in your path automatically. If you are performing a system-wide
3737
installation (using root or sudo), then all the other users must add
3838
the path to their environmental variables.
@@ -41,7 +41,7 @@ Linux install for Anaconda Python (assuming SAS already installed)
4141
package. The SASPy package is available from https://github.com/sassoftware/saspy.
4242
If the ``pip`` command in your path does not map to Python3, then use ``pip3``
4343
instead.
44-
::
44+
::
4545

4646
pip install sas_kernel
4747

@@ -72,17 +72,10 @@ Linux install for Anaconda Python (assuming SAS already installed)
7272

7373

7474
Use the `SASPy configuration documentation`_ to complete you set up.
75-
If you are using Linux or Unix the STDIO_ or `STDIO over SSH`_ will be the fastest connections, but IOM is also available
76-
All other systems will use *only* the IOM_ connection. If you want to connect to PC SAS on your local system, use `IOM Local`_
7775

78-
.. _STDIO: https://sassoftware.github.io/saspy/install.html#stdio
79-
.. _STDIO over SSH: https://sassoftware.github.io/saspy/install.html#stdio-over-ssh
80-
.. _IOM: https://sassoftware.github.io/saspy/install.html#iom
81-
.. _IOM Local: https://sassoftware.github.io/saspy/install.html#local
82-
.. _SASPy configuration documentation: https://sassoftware.github.io/saspy/install.html#configuration
76+
.. _SASPy configuration documentation: https://sassoftware.github.io/saspy/configuration.html
8377

84-
* Configuration documentation: https://sassoftware.github.io/saspy/install.html#configuration
85-
* GitHub version of the file: https://github.com/sassoftware/saspy/blob/master/saspy/sascfg.py
78+
* SASPy documentation: https://sassoftware.github.io/saspy/index.html
8679
* More information about SASPy: https://github.com/sassoftware/saspy
8780

8881

@@ -101,9 +94,9 @@ You must have Superuser privileges (root or sudo).
10194

10295
#. You can use the ``pip`` command.
10396
::
104-
105-
wget https://bootstrap.pypa.io/get-pip.py
106-
python3.5 get-pip.py
97+
98+
wget https://bootstrap.pypa.io/get-pip.py
99+
python3.5 get-pip.py
107100
pip3 --version``
108101

109102
#. Install Jupyter and the SAS kernel package. The package has a dependency on the SASPy
@@ -115,7 +108,7 @@ You must have Superuser privileges (root or sudo).
115108

116109
#. Verify that the SAS kernel package is installed.
117110
::
118-
111+
119112
jupyter kernelspec list
120113

121114
Your output should look similar to the following:
@@ -132,17 +125,10 @@ You must have Superuser privileges (root or sudo).
132125

133126

134127
Use the `SASPy configuration documentation`_ to complete you set up.
135-
If you are using Linux or Unix the STDIO_ or `STDIO over SSH`_ will be the fastest connections, but IOM is also available
136-
All other systems will use *only* the IOM_ connection. If you want to connect to PC SAS on your local system, use `IOM Local`_
137128

138-
.. _STDIO: https://sassoftware.github.io/saspy/install.html#stdio
139-
.. _STDIO over SSH: https://sassoftware.github.io/saspy/install.html#stdio-over-ssh
140-
.. _IOM: https://sassoftware.github.io/saspy/install.html#iom
141-
.. _IOM Local: https://sassoftware.github.io/saspy/install.html#local
142-
.. _SASPy configuration documentation: https://sassoftware.github.io/saspy/install.html#configuration
129+
.. _SASPy configuration documentation: https://sassoftware.github.io/saspy/configuration.html
143130

144-
* Configuration documentation: https://sassoftware.github.io/saspy/install.html#configuration
145-
* GitHub version of the file: https://github.com/sassoftware/saspy/blob/master/saspy/sascfg.py
131+
* SASPy documentation: https://sassoftware.github.io/saspy/index.html
146132
* More information about SASPy: https://github.com/sassoftware/saspy
147133

148134

@@ -157,7 +143,7 @@ Windows install (assuming SAS already installed)
157143
following:
158144

159145
* Install in the default location unless you have a good reason to change it.
160-
Using the default location simplifies administration.
146+
Using the default location simplifies administration.
161147

162148
.. image:: ./images/ap3.PNG
163149
:scale: 50%
@@ -169,7 +155,7 @@ Windows install (assuming SAS already installed)
169155
:scale: 50%
170156

171157
* Another installation prompt is to add the path to your environment. SAS
172-
recommends that you answer 'yes' to the prompt so that you get the
158+
recommends that you answer 'yes' to the prompt so that you get the
173159
executables in your path automatically. Adding the path your environment
174160
simplifies starting Python and Jupyter.
175161

@@ -186,7 +172,7 @@ Windows install (assuming SAS already installed)
186172
package. The SASPy package is available from https://github.com/sassoftware/saspy.
187173
If the ``pip`` command in your path does not map to Python3, then use ``pip3``
188174
instead.
189-
::
175+
::
190176

191177
pip install sas_kernel
192178

@@ -209,20 +195,12 @@ Windows install (assuming SAS already installed)
209195

210196

211197
Use the `SASPy configuration documentation`_ to complete you set up.
212-
If you are using Linux or Unix the STDIO_ or `STDIO over SSH`_ will be the fastest connections, but IOM is also available
213-
All other systems will use *only* the IOM_ connection. If you want to connect to PC SAS on your local system, use `IOM Local`_
214198

215-
.. _STDIO: https://sassoftware.github.io/saspy/install.html#stdio
216-
.. _STDIO over SSH: https://sassoftware.github.io/saspy/install.html#stdio-over-ssh
217-
.. _IOM: https://sassoftware.github.io/saspy/install.html#iom
218-
.. _IOM Local: https://sassoftware.github.io/saspy/install.html#local
219-
.. _SASPy configuration documentation: https://sassoftware.github.io/saspy/install.html#configuration
199+
.. _SASPy configuration documentation: https://sassoftware.github.io/saspy/configuration.html
220200

221-
* Configuration documentation: https://sassoftware.github.io/saspy/install.html#configuration
222-
* GitHub version of the file: https://github.com/sassoftware/saspy/blob/master/saspy/sascfg.py
201+
* SASPy documentation: https://sassoftware.github.io/saspy/index.html
223202
* More information about SASPy: https://github.com/sassoftware/saspy
224203

225-
.. NOTE:: For PC SAS (connecting to your local system), use the `IOM Local`_ connection instructions.
226204

227205

228206
*****************
@@ -236,21 +214,21 @@ OSX (Mac) install
236214
following:
237215

238216
* Install in the default location unless you have a good reason to change it.
239-
Using the default location simplifies administration.
217+
Using the default location simplifies administration.
240218

241219
* One installation prompt is to make Python accessible for just your account
242220
or for all users. Select the best response for your situation.
243221

244222
* Another installation prompt is to add the path to your environment. SAS
245-
recommends that you answer 'yes' to the prompt so that you get the
223+
recommends that you answer 'yes' to the prompt so that you get the
246224
executables in your path automatically. Adding the path your environment
247225
simplifies starting Python and Jupyter.
248226

249227
#. Install the SAS kernel package. The package has a dependency on the SASPy
250228
package. The SASPy package is available from https://github.com/sassoftware/saspy.
251229
If the ``pip`` command in your path does not map to Python3, then use ``pip3``
252230
instead.
253-
::
231+
::
254232

255233
pip install sas_kernel
256234

@@ -274,21 +252,12 @@ OSX (Mac) install
274252

275253

276254
Use the `SASPy configuration documentation`_ to complete you set up.
277-
If you are using Linux or Unix the STDIO_ or `STDIO over SSH`_ will be the fastest connections, but IOM is also available
278-
All other systems will use *only* the IOM_ connection. If you want to connect to PC SAS on your local system, use `IOM Local`_
279255

280-
.. _STDIO: https://sassoftware.github.io/saspy/install.html#stdio
281-
.. _STDIO over SSH: https://sassoftware.github.io/saspy/install.html#stdio-over-ssh
282-
.. _IOM: https://sassoftware.github.io/saspy/install.html#iom
283-
.. _IOM Local: https://sassoftware.github.io/saspy/install.html#local
284-
.. _SASPy configuration documentation: https://sassoftware.github.io/saspy/install.html#configuration
256+
.. _SASPy configuration documentation: https://sassoftware.github.io/saspy/configuration.html
285257

286-
* Configuration documentation: https://sassoftware.github.io/saspy/install.html#configuration
287-
* GitHub version of the file: https://github.com/sassoftware/saspy/blob/master/saspy/sascfg.py
258+
* SASPy documentation: https://sassoftware.github.io/saspy/index.html
288259
* More information about SASPy: https://github.com/sassoftware/saspy
289260

290-
.. NOTE:: For OSX, the only supported configuration is an IOM_ connection.
291-
292261

293262
===========================
294263
Installing SAS NBextensions
@@ -348,14 +317,14 @@ file structure as shown below:
348317
+-- theme
349318

350319
You can install the extensions from the command line. To install an extension
351-
system-wide, use the following command with Superuser privileges (root or
320+
system-wide, use the following command with Superuser privileges (root or
352321
sudo). The following command assumes that you are in the nbextensions
353-
directory. Adjust the path if you are not.
322+
directory. Adjust the path if you are not.
354323

355324
::
356325

357326
jupyter nbextension install ./showSASLog
358-
327+
359328
Your output should look similar to the following (installed with Superuser
360329
privileges):
361330

0 commit comments

Comments
 (0)
0