Skip to content

Commit 6c4c549

Browse files
committed
Documentation update for v0.1.1.
1 parent 2f32c0f commit 6c4c549

File tree

3 files changed

+33
-33
lines changed

3 files changed

+33
-33
lines changed

docs/facts.rst

+30-30
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ Apt
2424
2525
2626
27-
:code:`deb_package(name)`
28-
~~~~~~~~~~~~~~~~~~~~~~~~~
27+
:code:`deb_package`
28+
~~~~~~~~~~~~~~~~~~~
2929

3030

3131
Returns information on a .deb file.
@@ -93,53 +93,53 @@ Devices
9393
Files
9494
-----
9595

96-
:code:`directory(name)`
97-
~~~~~~~~~~~~~~~~~~~~~~~
96+
:code:`directory`
97+
~~~~~~~~~~~~~~~~~
9898

9999

100-
:code:`file(name)`
101-
~~~~~~~~~~~~~~~~~~
100+
:code:`file`
101+
~~~~~~~~~~~~
102102

103103

104-
:code:`find_directories(name)`
105-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
104+
:code:`find_directories`
105+
~~~~~~~~~~~~~~~~~~~~~~~~
106106

107107

108108
Returns a list of directories from a start point, recursively using find.
109109

110110

111111

112-
:code:`find_files(name)`
113-
~~~~~~~~~~~~~~~~~~~~~~~~
112+
:code:`find_files`
113+
~~~~~~~~~~~~~~~~~~
114114

115115

116116
Returns a list of files from a start point, recursively using find.
117117

118118

119119

120-
:code:`find_in_file(name)`
121-
~~~~~~~~~~~~~~~~~~~~~~~~~~
120+
:code:`find_in_file`
121+
~~~~~~~~~~~~~~~~~~~~
122122

123123

124124
Checks for the existence of text in a file using grep. Returns a list of matching
125125
lines if the file exists, and ``None`` if the file does not.
126126

127127

128128

129-
:code:`find_links(name)`
130-
~~~~~~~~~~~~~~~~~~~~~~~~
129+
:code:`find_links`
130+
~~~~~~~~~~~~~~~~~~
131131

132132

133133
Returns a list of links from a start point, recursively using find.
134134

135135

136136

137-
:code:`link(name)`
138-
~~~~~~~~~~~~~~~~~~
137+
:code:`link`
138+
~~~~~~~~~~~~
139139

140140

141-
:code:`sha1_file(name)`
142-
~~~~~~~~~~~~~~~~~~~~~~~
141+
:code:`sha1_file`
142+
~~~~~~~~~~~~~~~~~
143143

144144

145145
Returns a SHA1 hash of a file. Works with both sha1sum and sha1.
@@ -165,8 +165,8 @@ Gem
165165
Git
166166
---
167167

168-
:code:`git_branch(name)`
169-
~~~~~~~~~~~~~~~~~~~~~~~~
168+
:code:`git_branch`
169+
~~~~~~~~~~~~~~~~~~
170170

171171

172172
Init
@@ -232,8 +232,8 @@ Init
232232
Npm
233233
---
234234

235-
:code:`npm_local_packages(directory)`
236-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
235+
:code:`npm_local_packages`
236+
~~~~~~~~~~~~~~~~~~~~~~~~~~
237237

238238

239239
Returns a dict of locally installed npm packages in a given directory:
@@ -274,8 +274,8 @@ Pip
274274
275275
276276
277-
:code:`pip_virtualenv_packages(venv)`
278-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
277+
:code:`pip_virtualenv_packages`
278+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
279279

280280

281281
Pkg
@@ -301,8 +301,8 @@ Server
301301
~~~~~~~~~~~~
302302

303303

304-
:code:`command(command)`
305-
~~~~~~~~~~~~~~~~~~~~~~~~
304+
:code:`command`
305+
~~~~~~~~~~~~~~~
306306

307307

308308
:code:`date`
@@ -373,8 +373,8 @@ Returns the current datetime on the server.
373373
374374
375375
376-
:code:`which(name)`
377-
~~~~~~~~~~~~~~~~~~~
376+
:code:`which`
377+
~~~~~~~~~~~~~
378378

379379

380380
Yum
@@ -393,8 +393,8 @@ Yum
393393
394394
395395
396-
:code:`rpm_package(name)`
397-
~~~~~~~~~~~~~~~~~~~~~~~~~
396+
:code:`rpm_package`
397+
~~~~~~~~~~~~~~~~~~~
398398

399399

400400
Returns information on a .rpm file.

docs/modules/files.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ Download files from remote locations.
2929
.. code:: python
3030
3131
files.download(
32-
source_url, destination, user=None,
33-
group=None, mode=None, cache_time=None, force=False
32+
source_url, destination, user=None, group=None,
33+
mode=None, cache_time=None, force=False
3434
)
3535
3636
+ **source_url**: source URl of the file

docs/modules/git.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Manage git repositories.
99
.. code:: python
1010
1111
git.repo(
12-
source, target, branch=master, pull=True,
12+
source, target, branch='master', pull=True,
1313
rebase=False, user=None, group=None, use_ssh_user=False, ssh_keyscan=False
1414
)
1515

0 commit comments

Comments
 (0)