Skip to content

Commit

Permalink
Merge pull request #29 from PagerDuty/fix-pre-region
Browse files Browse the repository at this point in the history
Fix install instructions preformat block and add a copy in the User Guide
  • Loading branch information
Deconstrained authored Jan 3, 2025
2 parents 6aaf9bb + a49635e commit d5b01ba
Show file tree
Hide file tree
Showing 6 changed files with 27 additions and 6 deletions.
11 changes: 6 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,17 @@ python-pagerduty: Clients for PagerDuty's APIs
==============================================
A module that supplies lightweight Python clients for the PagerDuty REST API v2 and Events API v2.

For how-to, refer to the `User Guide
For in-depth usage documentation, refer to the `User Guide
<https://pagerduty.github.io/python-pagerduty/user_guide.html>`_.

Installation
------------
This library is available on PyPI as [pagerduty](https://pypi.org/project/pagerduty/), e.g.:
This library is available on PyPI as `pagerduty <https://pypi.org/project/pagerduty/>`_, e.g.:

.. code-block:: bash
pip install pagerduty
```
pip install pagerduty
```
Overview
--------
Expand Down
1 change: 1 addition & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ <h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Perm
<ul>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide.html">User Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user_guide.html#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide.html#authentication">Authentication</a><ul>
<li class="toctree-l3"><a class="reference internal" href="user_guide.html#using-non-us-service-regions">Using Non-US Service Regions</a></li>
<li class="toctree-l3"><a class="reference internal" href="user_guide.html#the-from-header">The From header</a></li>
Expand Down
Binary file modified docs/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/searchindex.js

Large diffs are not rendered by default.

8 changes: 8 additions & 0 deletions docs/user_guide.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">User Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="#authentication">Authentication</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#using-non-us-service-regions">Using Non-US Service Regions</a></li>
<li class="toctree-l3"><a class="reference internal" href="#the-from-header">The From header</a></li>
Expand Down Expand Up @@ -120,6 +121,13 @@
<span id="id1"></span><h1>User Guide<a class="headerlink" href="#user-guide" title="Permalink to this heading"></a></h1>
<p>This is a topical guide to general API client usage. <a class="reference internal" href="module_reference.html#module-reference"><span class="std std-ref">Module Reference</span></a>
has in-depth documentation on client classes and methods.</p>
<section id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this heading"></a></h2>
<p>This library is available on PyPI as <a class="reference external" href="https://pypi.org/project/pagerduty/">pagerduty</a>, e.g.:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip install pagerduty
</pre></div>
</div>
</section>
<section id="authentication">
<h2>Authentication<a class="headerlink" href="#authentication" title="Permalink to this heading"></a></h2>
<p>The first step is to construct a client object. The first argument to the
Expand Down
11 changes: 11 additions & 0 deletions sphinx/source/user_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,17 @@ User Guide
This is a topical guide to general API client usage. :ref:`module_reference`
has in-depth documentation on client classes and methods.



Installation
------------
This library is available on PyPI as `pagerduty <https://pypi.org/project/pagerduty/>`_, e.g.:

.. code-block:: bash
pip install pagerduty
Authentication
--------------
The first step is to construct a client object. The first argument to the
Expand Down

0 comments on commit d5b01ba

Please sign in to comment.