Merge pull request #297 from pcattori/simple-docs

Doc improvements

.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -44,6 +44,6 @@ Search open/closed issues before submitting since someone might have asked the s
 | Software          | Version(s) |
 | ----------------- | ---------- |
 | tamr-unify-client |
-| Tamr Unify server |
+| Tamr server       |
 | Python            |
 | Operating System  |

.github/ISSUE_TEMPLATE/QUESTION.md

@@ -30,6 +30,6 @@ Search open/closed issues before submitting since someone might have asked the s
 | Software          | Version(s) |
 | ----------------- | ---------- |
 | tamr-unify-client |
-| Tamr Unify server |
+| Tamr server       |
 | Python            |
 | Operating System  |

.github/PULL_REQUEST_TEMPLATE.md

@@ -19,7 +19,7 @@ Please look for any issues that this PR resolves and tag them in the PR.
 
 - [ ] Added/updated testing for this change
 - [ ] Included links to related issues/PRs
-- [ ] Update relevant [docs](https://github.com/Datatamer/unify-client-python/tree/master/docs) + docstrings
-- [ ] Update the [CHANGELOG](https://github.com/Datatamer/unify-client-python/blob/master/CHANGELOG.md) under the current `-dev` version:
+- [ ] Update relevant [docs](https://github.com/Datatamer/tamr-client/tree/master/docs) + docstrings
+- [ ] Update the [CHANGELOG](https://github.com/Datatamer/tamr-client/blob/master/CHANGELOG.md) under the current `-dev` version:
   - Add changelog entries under any that apply: **BREAKING CHANGES**, **NEW FEATURES**, **BUG FIXES**.
   - Changelog entry format: `[#<issue number>](<link to issue>) <change description>`

RELEASE.md

@@ -20,9 +20,9 @@ Ensure CI tests pass for your PR and merge your changes into `master`.
 
 # 2. Cut a release branch
 
-On the [Datatamer/unify-client-python](https://github.com/Datatamer/unify-client-python) Github repo, click on [Commits](https://github.com/Datatamer/unify-client-python/commits/master). Navigate to the commit just before the version bump commit from Step 1. Click the `<>` icon to browse the repo at that commit.
+On the [Datatamer/tamr-client](https://github.com/Datatamer/tamr-client) Github repo, click on [Commits](https://github.com/Datatamer/tamr-client/commits/master). Navigate to the commit just before the version bump commit from Step 1. Click the `<>` icon to browse the repo at that commit.
 
-Then, create a branch on Github within the [Datatamer/unify-client-python](https://github.com/Datatamer/unify-client-python) repo titled `release-<version>` e.g. `release-0.3.0`.
+Then, create a branch on Github within the [Datatamer/tamr-client](https://github.com/Datatamer/tamr-client) repo titled `release-<version>` e.g. `release-0.3.0`.
 
 Create a branch locally with the following commands:
 1. `git fetch Datatamer` (this will pull down the release branch you created on Github)
@@ -41,7 +41,7 @@ Ensure CI tests pass for your PR and merge your changes into the release branch
 
 # 4. Create a Github release
 
-On the [Datatamer/unify-client-python](https://github.com/Datatamer/unify-client-python) Github repo, click on [Releases](https://github.com/Datatamer/unify-client-python/releases). Click "Draft a new release".
+On the [Datatamer/tamr-client](https://github.com/Datatamer/tamr-client) Github repo, click on [Releases](https://github.com/Datatamer/tamr-client/releases). Click "Draft a new release".
 
 Title the release with the release version. Do not include anything else in the release title e.g.
 - Correct: `0.3.0`
@@ -52,13 +52,13 @@ Title the release with the release version. Do not include anything else in the
 
 Copy/paste the `CHANGELOG.md` entries for this release into the description for the release (only the entries, not the header since the version number is already encoded as the title for this release).
 
-Create the release. This should also implicitly create a tag for the release under [Tags](https://github.com/Datatamer/unify-client-python/tags).
+Create the release. This should also implicitly create a tag for the release under [Tags](https://github.com/Datatamer/tamr-client/tags).
 
 # 5. Check on published artifacts
 
 We use Travis CI as our Continuous Integration (CI) solution.
 
-CI is wired to ["deploy"](https://github.com/Datatamer/unify-client-python/blob/master/.travis.yml#L14) (a.k.a. publish) releases to PyPI for any tags that look like a semantic version number e.g. `0.3.0`. So CI should handle publishing for you.
+CI is wired to ["deploy"](https://github.com/Datatamer/tamr-client/blob/master/.travis.yml#L14) (a.k.a. publish) releases to PyPI for any tags that look like a semantic version number e.g. `0.3.0`. So CI should handle publishing for you.
 
 Check that CI tests passed.
 Check that CI successfully published the release version to [PyPI](https://pypi.org/project/tamr-unify-client/#history).

docs/conf.py

@@ -22,8 +22,8 @@
 
 # -- Project information -----------------------------------------------------
 
-project = "Tamr Unify Python Client"
-copyright = "2018, Tamr"
+project = "Tamr - Python Client"
+copyright = "2019, Tamr"
 author = "Tamr"
 
 
@@ -46,12 +46,12 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["sphinx.ext.autodoc", "sphinx.ext.intersphinx", "sphinx.ext.viewcode"]
+extensions = ["sphinx.ext.napoleon", "sphinx.ext.intersphinx", "sphinx.ext.viewcode"]
 autodoc_default_flags = ["inherited-members", "members"]
 autodoc_member_order = "bysource"
 intersphinx_mapping = {
     "https://docs.python.org/": None,
-    "requests": ("http://docs.python-requests.org/en/master/", None),
+    "requests": ("https://requests.kennethreitz.org/en/master/", None),
     "pandas": ("https://pandas.pydata.org/pandas-docs/stable", None),
 }
 
@@ -118,7 +118,7 @@
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = "TamrUnifyPythonClientdoc"
+htmlhelp_basename = "TamrPythonClientdoc"
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -144,8 +144,8 @@
 latex_documents = [
     (
         master_doc,
-        "TamrUnifyPythonClient.tex",
-        "Tamr Unify Python Client Documentation",
+        "TamrPythonClient.tex",
+        "Tamr - Python Client Documentation",
         "Tamr",
         "manual",
     )
@@ -157,13 +157,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (
-        master_doc,
-        "tamrunifypythonclient",
-        "Tamr Unify Python Client Documentation",
-        [author],
-        1,
-    )
+    (master_doc, "tamrpythonclient", "Tamr - Python Client Documentation", [author], 1)
 ]
 
 
@@ -175,10 +169,10 @@
 texinfo_documents = [
     (
         master_doc,
-        "TamrUnifyPythonClient",
-        "Tamr Unify Python Client Documentation",
+        "TamrPythonClient",
+        "Tamr - Python Client Documentation",
         author,
-        "TamrUnifyPythonClient",
+        "TamrPythonClient",
         "One line description of project.",
         "Miscellaneous",
     )

docs/index.rst

@@ -1,7 +1,7 @@
-Tamr Unify - Python Client
+Tamr - Python Client
 ==========================
 
-Version: |release| | `View on Github <https://github.com/Datatamer/unify-client-python>`_
+Version: |release| | `View on Github <https://github.com/Datatamer/tamr-client>`_
 
 Example
 -------

docs/user-guide/spec.rst

@@ -86,7 +86,7 @@ Modifying a resource
 Certain resources can also be modified using specs.
 
 After getting a spec corresponding to a resource and modifying some properties,
-the updated resource can be committed to Unify with the ``put`` function::
+the updated resource can be committed to Tamr with the ``put`` function::
 
     updated_dataset = (
         dataset.spec()