Merge pull request #49 from treasure-data/doc-update

Update documentation site with new theme & config file

.readthedocs.yml

@@ -0,0 +1,26 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: doc/conf.py
+
+# Build documentation with MkDocs
+#mkdocs:
+#  configuration: mkdocs.yml
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats: []
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.7
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - spark
+        - doc

CHANGELOG.rst

@@ -1,8 +1,8 @@
 Changelog
 =========
 
-0.8.0 (2019-09-17)
-------------------
+v0.8.0 (2019-09-17)
+-------------------
 
 -  Clean up docstrings and launch documentation site.
    (`#43 <https://github.com/treasure-data/pytd/pull/43>`__, `#44 <https://github.com/treasure-data/pytd/pull/44>`__)
@@ -11,8 +11,8 @@ Changelog
 -  Add `td-pyspark <https://pypi.org/project/td-pyspark/>`__ dependency for easily accessing to the `td-spark <https://support.treasuredata.com/hc/en-us/articles/360001487167-Apache-Spark-Driver-td-spark-FAQs>`__ functionalities.
    (`#46 <https://github.com/treasure-data/pytd/pull/46>`__, `#47 <https://github.com/treasure-data/pytd/pull/47>`__)
 
-0.7.0 (2019-08-23)
-------------------
+v0.7.0 (2019-08-23)
+-------------------
 
 -  Support ``if_exists="append"`` option in ``BulkImportWriter``.
    (`#38 <https://github.com/treasure-data/pytd/pull/38>`__)

doc/conf.py

@@ -94,9 +94,8 @@ def linkcode_resolve(domain, info):
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
-    "sphinx.ext.doctest",
-    "sphinx.ext.githubpages",
     "numpydoc",
+    "sphinx_rtd_theme",
     "sphinx.ext.linkcode",
 ]
 
@@ -124,12 +123,7 @@ def linkcode_resolve(domain, info):
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "alabaster"
-html_theme_options = {
-    "description": "Treasure Data Driver for Python",
-    "github_user": GH_ORGANIZATION,
-    "github_repo": GH_PROJECT,
-}
+html_theme = "sphinx_rtd_theme"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

setup.py

@@ -70,6 +70,7 @@ def setup_package():
         extras_require={
             "spark": ["td-pyspark>=19.9.0", "pyspark>=2.4.0", "pyarrow>=0.11.0"],
             "test": ["pytest"],
+            "doc": ["sphinx>=2.2.0", "sphinx_rtd_theme", "numpydoc", "ipython"],
         },
     )