Merge 4ae48ba into 905b6c3

tchellomello · Jan 30, 2024 · 6565343 · 6565343
2 parents 905b6c3 + 4ae48ba
commit 6565343
Show file tree

Hide file tree

Showing 7 changed files with 55 additions and 801 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -138,3 +138,20 @@ the install script above or pipx.
 
 See `poetry documentation <https://python-poetry.org/>`_ for more info
 
+Documentation
+^^^^^^^^^^^^^
+
+To build the docs install with the docs extra::
+
+    $ poetry install --extras docs
+
+Then generate a `Github access token <https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token>`_
+(no permissions are needed) and export it as follows::
+
+    $ export CHANGELOG_GITHUB_TOKEN="«your-40-digit-github-token»"
+
+Then build::
+
+    $ make -C html
+
+You can add the token to your shell profile to avoid having to export it each time. (e.g., .env, ~/.bash_profile, ~/.bashrc, ~/.zshrc, etc)
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
@@ -1 +1,8 @@
-.. include:: ../../CHANGELOG.rst
+=========
+Changelog
+=========
+
+.. changelog::
+   :changelog-url: https://python-ring-doorbell.readthedocs.io/changelog.html
+   :github: https://github.com/tchellomello/python-ring-doorbell/releases/
+   :pypi: https://pypi.org/project/ring-doorbell/
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -2,6 +2,7 @@
 #
 # For the full list of built-in configuration values, see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
+import os
 from importlib.metadata import version as _version
 
 # -- Project information -----------------------------------------------------
@@ -21,6 +22,7 @@
     "sphinx.ext.coverage",
     "sphinx.ext.viewcode",
     "sphinx.ext.todo",
+    "sphinx_github_changelog",
 ]
 
 templates_path = ["_templates"]
@@ -31,3 +33,5 @@
 
 html_theme = "sphinx_rtd_theme"
 html_static_path = ["_static"]
+master_doc = "index"
+sphinx_github_changelog_token = os.environ.get("CHANGELOG_GITHUB_TOKEN")
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -6,6 +6,7 @@
 Welcome to python-ring-doorbell's documentation!
 ================================================
 
+
 .. include:: ../../README.rst
 
 .. toctree::
@@ -17,3 +18,5 @@ Welcome to python-ring-doorbell's documentation!
    contributing
    changelog
 
+
+
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -48,6 +48,7 @@ asyncclick = ">=8"
 anyio = "*" # see https://github.com/python-trio/asyncclick/issues/18
 sphinx = {version = "<7.2.6", optional = true}
 sphinx-rtd-theme = {version = "^1.3.0", optional = true}
+sphinx-github-changelog = {version = "^1.2.1", optional = true}
 firebase-messaging = {version = "^0.2.0", optional = true}
 
 [tool.poetry.group.dev.dependencies]
@@ -58,15 +59,14 @@ pylint = "*"
 pytest = "*"
 pytest-cov = "*"
 requests-mock = "*"
-sphinx-github-changelog = "^1.2.1"
 tox = "*"
 pytest-asyncio = "*"
 pytest-mock = "*"
 black = "*"
 pytest-socket = "^0.6.0"
 
 [tool.poetry.extras]
-docs = ["sphinx", "sphinx-rtd-theme"]
+docs = ["sphinx", "sphinx-rtd-theme", "sphinx-github-changelog"]
 listen = ["firebase-messaging"]
 
 [tool.pytest.ini_options]