Merge pull request #7 from PagerDuty/final-pdpyras-doc-replacements

Final "pdpyras" replacements
PagerDuty · Dec 18, 2024 · b3c9345 · b3c9345
2 parents 82774b4 + 3cb0ae1
commit b3c9345
Show file tree

Hide file tree

Showing 8 changed files with 19 additions and 29 deletions.
diff --git a/README.rst b/README.rst
@@ -92,6 +92,7 @@ Warranty
 .. -----------
 
 .. _`Requests`: https://docs.python-requests.org/en/master/
+.. _`pdpyras`: https://github.com/PagerDuty/pdpyras
 .. _`Errors`: https://developer.pagerduty.com/docs/ZG9jOjExMDI5NTYz-errors
 .. _`Events API v2`: https://developer.pagerduty.com/docs/ZG9jOjExMDI5NTgw-events-api-v2-overview
 .. _`PagerDuty API Reference`: https://developer.pagerduty.com/api-reference/

diff --git a/docs/changelog.html b/docs/changelog.html
@@ -20,7 +20,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="User Guide" href="user_guide.html" />
-    <link rel="prev" title="PDPYRAS: PagerDuty Python REST API Sessions" href="index.html" /> 
+    <link rel="prev" title="python-pagerduty: Clients for PagerDuty’s public APIs" href="index.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -85,7 +85,7 @@ <h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this he
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="index.html" class="btn btn-neutral float-left" title="PDPYRAS: PagerDuty Python REST API Sessions" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="index.html" class="btn btn-neutral float-left" title="python-pagerduty: Clients for PagerDuty’s public APIs" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="user_guide.html" class="btn btn-neutral float-right" title="User Guide" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 

diff --git a/docs/index.html b/docs/index.html
@@ -6,7 +6,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>PDPYRAS: PagerDuty Python REST API Sessions &mdash; python-pagerduty 0.1.0 documentation</title>
+  <title>python-pagerduty: Clients for PagerDuty’s public APIs &mdash; python-pagerduty 0.1.0 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b76e3c8a" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
 
@@ -62,7 +62,7 @@
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
       <li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
-      <li class="breadcrumb-item active">PDPYRAS: PagerDuty Python REST API Sessions</li>
+      <li class="breadcrumb-item active">python-pagerduty: Clients for PagerDuty’s public APIs</li>
       <li class="wy-breadcrumbs-aside">
             <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
       </li>
@@ -72,8 +72,8 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <section id="pdpyras-pagerduty-python-rest-api-sessions">
-<h1>PDPYRAS: PagerDuty Python REST API Sessions<a class="headerlink" href="#pdpyras-pagerduty-python-rest-api-sessions" title="Permalink to this heading"></a></h1>
+  <section id="python-pagerduty-clients-for-pagerduty-s-public-apis">
+<h1>python-pagerduty: Clients for PagerDuty’s public APIs<a class="headerlink" href="#python-pagerduty-clients-for-pagerduty-s-public-apis" title="Permalink to this heading"></a></h1>
 <section id="external-resources">
 <h2>External Resources<a class="headerlink" href="#external-resources" title="Permalink to this heading"></a></h2>
 <ul class="simple">

diff --git a/docs/objects.inv b/docs/objects.inv
diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/release.sh b/release.sh
diff --git a/scripts/get_path_list/get_path_list.py b/scripts/get_path_list/get_path_list.py
@@ -5,16 +5,16 @@
 #   PATH must be a path to "reference/v2/Index.yaml" within a clone of the API
 #   source code repository.
 
-# This script is not part of the pdpyras library. Rather, it can be used for the
-# by PagerDuty engineers to assist the development and maintenance of pdpyras.
-# It automatically generates the declaration of module variables
-# "ENDPOINT_PATTERNS" and "CURSOR_BASED_ITERATION_ENDPOINTS" from the API
-# documentation source code (which is kept in a private repository in the
+# This script is not part of the python-pagerduty library. Rather, it can be used for
+# the by PagerDuty engineers to assist with its development and maintenance.  It
+# automatically generates the declaration of module variables "ENDPOINT_PATTERNS" and
+# "CURSOR_BASED_ITERATION_ENDPOINTS" from the API documentation source code (which is
+# kept in a private repository in the
 # PagerDuty GitHub org).
 #
-# It is meant to minimize the amount of work that has to be done to allow
-# pdpyras to support new APIs by generating the client's specific knowledge
-# of APIs directly from the documentation programatically.
+# It is meant to minimize the amount of work that has to be done to allow the REST API
+# v2 client to support new APIs by generating the client's specific knowledge of APIs
+# directly from the documentation programatically.
 
 # NOTE:
 #

diff --git a/sphinx/source/index.rst b/sphinx/source/index.rst
@@ -1,6 +1,6 @@
-===========================================
-PDPYRAS: PagerDuty Python REST API Sessions
-===========================================
+=====================================================
+python-pagerduty: Clients for PagerDuty's public APIs
+=====================================================
 
 External Resources
 ------------------