Skip to content

Commit 1752822

Browse files
committed
Rebuild docs
1 parent 98e00ae commit 1752822

12 files changed

+42
-21
lines changed

docs/_static/documentation_options.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const DOCUMENTATION_OPTIONS = {
2-
VERSION: '2.1.0',
2+
VERSION: '2.1.2',
33
LANGUAGE: 'en',
44
COLLAPSE_INDEX: false,
55
BUILDER: 'html',

docs/changelog.html

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>Changelog &mdash; python-pagerduty 2.1.0 documentation</title>
9+
<title>Changelog &mdash; python-pagerduty 2.1.2 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
1111
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
1212

1313

1414
<script src="_static/jquery.js?v=5d32c60e"></script>
1515
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
16-
<script src="_static/documentation_options.js?v=20623aea"></script>
16+
<script src="_static/documentation_options.js?v=841abef3"></script>
1717
<script src="_static/doctools.js?v=9bcbadda"></script>
1818
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1919
<script src="_static/js/theme.js"></script>
@@ -76,6 +76,27 @@
7676

7777
<section id="changelog">
7878
<h1>Changelog<a class="headerlink" href="#changelog" title="Link to this heading"></a></h1>
79+
<p><strong>2025-05-19: Bug fixes for iter_cursor and HTTP 204 response handling</strong></p>
80+
<ul>
81+
<li><p>Allow <code class="docutils literal notranslate"><span class="pre">try_decoding</span></code> to return <code class="docutils literal notranslate"><span class="pre">None</span></code> for empty input; fixes GitHub issue #46.</p></li>
82+
<li><p>Non-breaking changes to <code class="docutils literal notranslate"><span class="pre">RestApiV2Client.iter_cursor</span></code>, to fix GitHub issue #45:</p>
83+
<blockquote>
84+
<div><ul class="simple">
85+
<li><p>It now uses the <code class="docutils literal notranslate"><span class="pre">default_page_size</span></code> client setting as the <code class="docutils literal notranslate"><span class="pre">limit</span></code> parameter.</p></li>
86+
<li><p>It accepts a <code class="docutils literal notranslate"><span class="pre">page_size</span></code> parameter that can override said default (and <code class="docutils literal notranslate"><span class="pre">params</span></code> can also override this default), similar to <code class="docutils literal notranslate"><span class="pre">iter_all</span></code>.</p></li>
87+
<li><p>When called indirectly via <code class="docutils literal notranslate"><span class="pre">iter_all</span></code>, the <code class="docutils literal notranslate"><span class="pre">item_hook</span></code> keyword argument is passed through to it, along with <code class="docutils literal notranslate"><span class="pre">page_size</span></code>.</p></li>
88+
</ul>
89+
</div></blockquote>
90+
</li>
91+
</ul>
92+
<p><strong>2025-05-14: Bug fix - Version 2.1.2</strong></p>
93+
<ul class="simple">
94+
<li><p>The “main” method in the entry script is expected to receive no arguments, but in v2.1.0, it requires one positional argument.</p></li>
95+
</ul>
96+
<p><strong>2025-05-13: Command line interface - Version 2.1.0</strong></p>
97+
<ul class="simple">
98+
<li><p>Add a basic command line interface for Events API v2, for feature parity with the legacy library that is used in the <a class="reference external" href="https://www.pagerduty.com/docs/guides/monit-integration-guide/">Monit Integration Guide</a>.</p></li>
99+
</ul>
79100
<p><strong>2025-04-08: Multi-file refactor - Version 2.0.0</strong></p>
80101
<p>This release introduces major structural changes to the module and how it is built and tested. These changes were made for long-term maintainability of the codebase. Previously, it was all contained within a monolithic <code class="docutils literal notranslate"><span class="pre">.py</span></code> file (with a single Python script for all unit tests); now it is organized into smaller, appropriately-named Python files.</p>
81102
<p>Some lesser changes are also included:</p>

docs/contributing.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>Contribution Guide &mdash; python-pagerduty 2.1.0 documentation</title>
9+
<title>Contribution Guide &mdash; python-pagerduty 2.1.2 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
1111
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
1212

1313

1414
<script src="_static/jquery.js?v=5d32c60e"></script>
1515
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
16-
<script src="_static/documentation_options.js?v=20623aea"></script>
16+
<script src="_static/documentation_options.js?v=841abef3"></script>
1717
<script src="_static/doctools.js?v=9bcbadda"></script>
1818
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1919
<script src="_static/js/theme.js"></script>

docs/genindex.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>Index &mdash; python-pagerduty 2.1.0 documentation</title>
8+
<title>Index &mdash; python-pagerduty 2.1.2 documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
1010
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
1111

1212

1313
<script src="_static/jquery.js?v=5d32c60e"></script>
1414
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
15-
<script src="_static/documentation_options.js?v=20623aea"></script>
15+
<script src="_static/documentation_options.js?v=841abef3"></script>
1616
<script src="_static/doctools.js?v=9bcbadda"></script>
1717
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1818
<script src="_static/js/theme.js"></script>

docs/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>python-pagerduty: Clients for PagerDuty’s APIs &mdash; python-pagerduty 2.1.0 documentation</title>
9+
<title>python-pagerduty: Clients for PagerDuty’s APIs &mdash; python-pagerduty 2.1.2 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
1111
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
1212

1313

1414
<script src="_static/jquery.js?v=5d32c60e"></script>
1515
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
16-
<script src="_static/documentation_options.js?v=20623aea"></script>
16+
<script src="_static/documentation_options.js?v=841abef3"></script>
1717
<script src="_static/doctools.js?v=9bcbadda"></script>
1818
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1919
<script src="_static/js/theme.js"></script>

docs/module_reference.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>Module Reference &mdash; python-pagerduty 2.1.0 documentation</title>
9+
<title>Module Reference &mdash; python-pagerduty 2.1.2 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
1111
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
1212

1313

1414
<script src="_static/jquery.js?v=5d32c60e"></script>
1515
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
16-
<script src="_static/documentation_options.js?v=20623aea"></script>
16+
<script src="_static/documentation_options.js?v=841abef3"></script>
1717
<script src="_static/doctools.js?v=9bcbadda"></script>
1818
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1919
<script src="_static/js/theme.js"></script>
@@ -615,7 +615,7 @@ <h2>API Client Classes<a class="headerlink" href="#api-client-classes" title="Li
615615

616616
<dl class="py method">
617617
<dt class="sig sig-object py" id="pagerduty.RestApiV2Client.iter_cursor">
618-
<span class="sig-name descname"><span class="pre">iter_cursor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item_hook</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Iterator</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pagerduty.RestApiV2Client.iter_cursor" title="Link to this definition"></a></dt>
618+
<span class="sig-name descname"><span class="pre">iter_cursor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">item_hook</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">page_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Iterator</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pagerduty.RestApiV2Client.iter_cursor" title="Link to this definition"></a></dt>
619619
<dd><p>Iterator for results from an endpoint using cursor-based pagination.</p>
620620
<dl class="field-list simple">
621621
<dt class="field-odd">Parameters<span class="colon">:</span></dt>

docs/objects.inv

0 Bytes
Binary file not shown.

docs/pdpyras_migration_guide.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>PDPYRAS Migration Guide &mdash; python-pagerduty 2.1.0 documentation</title>
9+
<title>PDPYRAS Migration Guide &mdash; python-pagerduty 2.1.2 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
1111
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
1212

1313

1414
<script src="_static/jquery.js?v=5d32c60e"></script>
1515
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
16-
<script src="_static/documentation_options.js?v=20623aea"></script>
16+
<script src="_static/documentation_options.js?v=841abef3"></script>
1717
<script src="_static/doctools.js?v=9bcbadda"></script>
1818
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1919
<script src="_static/js/theme.js"></script>

docs/py-modindex.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>Python Module Index &mdash; python-pagerduty 2.1.0 documentation</title>
8+
<title>Python Module Index &mdash; python-pagerduty 2.1.2 documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
1010
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
1111

1212

1313
<script src="_static/jquery.js?v=5d32c60e"></script>
1414
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
15-
<script src="_static/documentation_options.js?v=20623aea"></script>
15+
<script src="_static/documentation_options.js?v=841abef3"></script>
1616
<script src="_static/doctools.js?v=9bcbadda"></script>
1717
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1818
<script src="_static/js/theme.js"></script>

docs/search.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>Search &mdash; python-pagerduty 2.1.0 documentation</title>
8+
<title>Search &mdash; python-pagerduty 2.1.2 documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
1010
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
1111

1212

1313

1414
<script src="_static/jquery.js?v=5d32c60e"></script>
1515
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
16-
<script src="_static/documentation_options.js?v=20623aea"></script>
16+
<script src="_static/documentation_options.js?v=841abef3"></script>
1717
<script src="_static/doctools.js?v=9bcbadda"></script>
1818
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1919
<script src="_static/js/theme.js"></script>

docs/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/user_guide.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>User Guide &mdash; python-pagerduty 2.1.0 documentation</title>
9+
<title>User Guide &mdash; python-pagerduty 2.1.2 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
1111
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
1212

1313

1414
<script src="_static/jquery.js?v=5d32c60e"></script>
1515
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
16-
<script src="_static/documentation_options.js?v=20623aea"></script>
16+
<script src="_static/documentation_options.js?v=841abef3"></script>
1717
<script src="_static/doctools.js?v=9bcbadda"></script>
1818
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1919
<script src="_static/js/theme.js"></script>

0 commit comments

Comments
 (0)