Merge pull request #29 from escapewindow/master

doc updates
scriptharness · Jun 25, 2015 · c44435c · c44435c
2 parents 238872d + c1ef2c2
commit c44435c
Show file tree

Hide file tree

Showing 6 changed files with 49 additions and 2 deletions.
diff --git a/README b/README
@@ -60,6 +60,16 @@ This is in the same spirit of other frameworks that allow for discrete
 targets, tasks, or actions: make, maven, ansible, and many more.
 
 
+Install
+=======
+
+   # This will automatically bring in all requirements.
+   pip install scriptharness
+
+   # To do a full install with docs/testing requirements,
+   pip install -r requirements.txt
+
+
 Running unit tests
 ==================
 

diff --git a/README.rst b/README.rst
@@ -38,6 +38,18 @@ Scriptharness actions allow for:
 
 This is in the same spirit of other frameworks that allow for discrete targets, tasks, or actions: make, maven, ansible, and many more.
 
+#######
+Install
+#######
+
+::
+
+    # This will automatically bring in all requirements.
+    pip install scriptharness
+
+    # To do a full install with docs/testing requirements,
+    pip install -r requirements.txt
+
 ##################
 Running unit tests
 ##################

diff --git a/docs/README.rst b/docs/README.rst
@@ -34,6 +34,18 @@ Scriptharness actions allow for:
 
 This is in the same spirit of other frameworks that allow for discrete targets, tasks, or actions: make, maven, ansible, and many more.
 
+#######
+Install
+#######
+
+::
+
+    # This will automatically bring in all requirements.
+    pip install scriptharness
+
+    # To do a full install with docs/testing requirements,
+    pip install -r requirements.txt
+
 ##################
 Running unit tests
 ##################

diff --git a/docs/README.rst.j2 b/docs/README.rst.j2
@@ -34,6 +34,18 @@ Scriptharness actions allow for:
 
 This is in the same spirit of other frameworks that allow for discrete targets, tasks, or actions: make, maven, ansible, and many more.
 
+#######
+Install
+#######
+
+::
+
+    # This will automatically bring in all requirements.
+    pip install scriptharness
+
+    # To do a full install with docs/testing requirements,
+    pip install -r requirements.txt
+
 ##################
 Running unit tests
 ##################

diff --git a/docs/build_docs.py b/docs/build_docs.py
@@ -118,7 +118,8 @@ def main():
     build_readme_rst()
     build_releasenotes_rst()
     build_quickstart()
-    subprocess.check_call(["make", "html"])
+    subprocess.check_call(["make", "clean", "html"])
+    subprocess.check_call(["make", "dirhtml"])
     subprocess.check_call(["make", "text"])
     subprocess.check_call(["cp", "_build/text/README.txt", "../README"])
     if os.path.exists("artifacts"):

diff --git a/setup.py b/setup.py
@@ -36,7 +36,7 @@ def read(fname):
     long_description=read('README'),
     author='Aki Sasaki',
     author_email='aki@escapewindow.com',
-    url='https://github.com/scriptharness/scriptharness',
+    url='https://github.com/scriptharness/python-scriptharness',
     license='MPL2',
     packages=find_packages(exclude=['ez_setup', 'examples', 'tests']),
     include_package_data=True,