Renaming variable in tests.

Also touching up Sphinx docs.

Author: Robpol86

docs/github_pages.rst

@@ -52,7 +52,7 @@ Running in CI
 The goal of using GitHub Pages is to have docs automatically update on every new/changed branch/tag. In this example
 we'll be using Travis CI but any CI should work.
 
-Travis won't be able to push any changes to the gh-pages branch without SSH keys. This guide will worry about just
+Travis won't be able to push any changes to the gh-pages branch without SSH keys. This section will worry about just
 getting Travis to run SCVersioning. It should only fail when trying to push to origin.
 
 CI Config File
@@ -122,7 +122,7 @@ The ``travis encrypt-file`` command should have updated your ``.travis.yml`` wit
 we still need to make one more change to the file before committing it. Update .travis.yml to make the after_success
 section look like this:
 
-.. code-block:: bash
+.. code-block:: yaml
 
     after_success:
       - eval "$(ssh-agent -s)"; touch docs/key; chmod 0600 docs/key

tests/test__main__/test_main_push_scenarios.py

@@ -172,27 +172,27 @@ def test_second_remote(tmpdir, local_docs_ghp, run, urls):
     :param run: conftest fixture.
     :param urls: conftest fixture.
     """
-    # Error out because origin2 doesn't exist yet.
+    # Error out because remote2 doesn't exist yet.
     with pytest.raises(CalledProcessError) as exc:
-        run(local_docs_ghp, ['sphinx-versioning', 'push', '.', 'gh-pages', '.', '-P', 'origin2'])
+        run(local_docs_ghp, ['sphinx-versioning', 'push', '.', 'gh-pages', '.', '-P', 'remote2'])
     assert 'Traceback' not in exc.value.output
     assert 'Failed to push to remote.' in exc.value.output
-    assert "fatal: 'origin2' does not appear to be a git repository" in exc.value.output
+    assert "fatal: 'remote2' does not appear to be a git repository" in exc.value.output
 
-    # Create origin2.
-    origin2 = tmpdir.ensure_dir('origin2')
-    run(origin2, ['git', 'init', '--bare'])
-    run(local_docs_ghp, ['git', 'remote', 'add', 'origin2', origin2])
-    run(local_docs_ghp, ['git', 'push', 'origin2', 'gh-pages'])
+    # Create remote2.
+    remote2 = tmpdir.ensure_dir('remote2')
+    run(remote2, ['git', 'init', '--bare'])
+    run(local_docs_ghp, ['git', 'remote', 'add', 'remote2', remote2])
+    run(local_docs_ghp, ['git', 'push', 'remote2', 'gh-pages'])
 
     # Run again.
-    output = run(local_docs_ghp, ['sphinx-versioning', 'push', '.', 'gh-pages', '.', '-P', 'origin2'])
+    output = run(local_docs_ghp, ['sphinx-versioning', 'push', '.', 'gh-pages', '.', '-P', 'remote2'])
     assert 'Traceback' not in output
     assert 'Successfully pushed to remote repository.' in output
 
     # Check files.
-    run(local_docs_ghp, ['git', 'checkout', 'origin2/gh-pages'])
-    run(local_docs_ghp, ['git', 'pull', 'origin2', 'gh-pages'])
+    run(local_docs_ghp, ['git', 'checkout', 'remote2/gh-pages'])
+    run(local_docs_ghp, ['git', 'pull', 'remote2', 'gh-pages'])
     urls(local_docs_ghp.join('contents.html'), ['<li><a href="master/contents.html">master</a></li>'])
     urls(local_docs_ghp.join('master', 'contents.html'), ['<li><a href="contents.html">master</a></li>'])
     run(local_docs_ghp, ['git', 'checkout', 'origin/gh-pages'])