[dolphinscheduler-sdk-python] branch main updated: [feat] Add changelog to our documentation (#44)

[zh...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

zhongjiajie pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/dolphinscheduler-sdk-python.git


The following commit(s) were added to refs/heads/main by this push:
     new 8692ceb  [feat] Add changelog to our documentation (#44)
8692ceb is described below

commit 8692cebdf746fde023e70596e1c1157c533a8dbf
Author: Jay Chung <zh...@gmail.com>
AuthorDate: Fri Dec 16 17:36:31 2022 +0800

    [feat] Add changelog to our documentation (#44)
---
 docs/source/changelog.rst | 7 +++++++
 docs/source/conf.py       | 8 +++++++-
 docs/source/index.rst     | 1 +
 setup.py                  | 1 +
 4 files changed, 16 insertions(+), 1 deletion(-)

diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
new file mode 100644
index 0000000..f045c26
--- /dev/null
+++ b/docs/source/changelog.rst
@@ -0,0 +1,7 @@
+Changelog
+=========
+
+.. changelog::
+    :changelog-url: https://dolphinscheduler.apache.org/python/main#changelog
+    :github: https://github.com/apache/dolphinscheduler-sdk-python/releases/
+    :pypi: https://pypi.org/project/apache-dolphinscheduler/
diff --git a/docs/source/conf.py b/docs/source/conf.py
index c7aa6d3..257b342 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -26,7 +26,7 @@
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-
+import base64
 import os
 import sys
 from pathlib import Path
@@ -75,6 +75,7 @@ extensions = [
     "sphinx_inline_tabs",
     "sphinx_copybutton",
     "sphinx_multiversion",
+    "sphinx_github_changelog",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -108,6 +109,11 @@ autodoc_default_options = {
 
 autosectionlabel_prefix_document = True
 
+# extensions for sphinx_github_changelog, token from Jay Chung with only public_repo permission. have to
+# encode it due to github will delete token string if it is not encoded.
+token_encode = b"Z2hwX2tXa09kdTI0N3RVcmJlREVVeEJINUhWOVZBblVwQjNJNXNLeg=="
+sphinx_github_changelog_token = base64.b64decode(token_encode).decode()
+
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
diff --git a/docs/source/index.rst b/docs/source/index.rst
index bd6a752..c9b69fc 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -104,6 +104,7 @@ then go and see :doc:`tutorial` for more detail.
    config
    api
    resources_plugin/index
+   changelog
 
 Indices and tables
 ==================
diff --git a/setup.py b/setup.py
index 6d926a1..7ee2053 100644
--- a/setup.py
+++ b/setup.py
@@ -60,6 +60,7 @@ doc = [
     # GitHub directly, see also:
     # https://github.com/Holzhaus/sphinx-multiversion/issues/42#issuecomment-1210539786
     "sphinx-multiversion @ git+https://github.com/Holzhaus/sphinx-multiversion#egg=sphinx-multiversion",
+    "sphinx-github-changelog",
 ]
 
 test = [