chore(python-docs): update python doc assets to recent development st…

…ate (#184)
apache · Jun 22, 2024 · 32bb589 · 32bb589
1 parent abf1755
commit 32bb589
Show file tree

Hide file tree

Showing 51 changed files with 632 additions and 104 deletions.
diff --git a/docs-python/dev/getting-started/developing/index.html b/docs-python/dev/getting-started/developing/index.html
@@ -2366,7 +2366,7 @@ <h2 id="development-guide">📖 Development Guide<a class="headerlink" href="#de
 <br></p>
 <h3 id="first-steps">🚀 First Steps<a class="headerlink" href="#first-steps" title="Permanent link">&para;</a></h3>
 <p>1) <strong>Set up your Python environment</strong></p>
-<p>Create a virtual Python environment using a tool of your choice. 
+<p>Create a virtual Python environment using a tool of your choice.
 To manage dependencies, we use <a href="https://python-poetry.org/">Poetry</a>, so please install poetry in your local environment, e.g. via
 <div class="language-bash highlight"><pre><span></span><code>pip<span class="w"> </span>install<span class="w"> </span>poetry
 </code></pre></div></p>
@@ -2379,7 +2379,7 @@ <h3 id="first-steps">🚀 First Steps<a class="headerlink" href="#first-steps" t
 <p>2) <strong>Install pre-commit hook</strong></p>
 <p>The pre-commit hook is run before every commit and takes care about code style,
 linting, type hints, import sorting, etc. It will stop your commit in case the changes do not apply the expected format.
-Always check to have the recent version of the pre-commit hook installed otherwise the CI build might fail. 
+Always check to have the recent version of the pre-commit hook installed otherwise the CI build might fail.
 If you are interested, you can have a deeper look on the underlying library: <a href="https://pre-commit.com/">pre-commit</a>.</p>
 <p><div class="language-bash highlight"><pre><span></span><code>pre-commit<span class="w"> </span>install
 </code></pre></div>
@@ -2395,7 +2395,7 @@ <h3 id="conventions">👏 Conventions<a class="headerlink" href="#conventions" t
 <p>2) <strong>Provide tests</strong> ✅ <br>
 We are aiming for broad test coverage for the Python package and
 have therefore set a requirement of at least 90% unit test coverage.
-Therefore, please remember to write (unit) tests already during development. 
+Therefore, please remember to write (unit) tests already during development.
 If you have problems with writing tests, don't hesitate to ask us for help directly in the PR or
 even before that via our mailing list (see above).</p>
 <!---
@@ -2439,7 +2439,7 @@ <h2 id="roadmap">🚀 Roadmap<a class="headerlink" href="#roadmap" title="Perman
 <p>Stay tuned!</p>
 <hr />
 <h2 id="contributing">👨‍💻 Contributing<a class="headerlink" href="#contributing" title="Permanent link">&para;</a></h2>
-<p><em>Before opening a pull request</em>, review the <a href="https://streampipes.apache.org/getinvolved.html">Get Involved</a> page.
+<p><em>Before opening a pull request</em>, review the <a href="https://streampipes.apache.org/community/get-involved/">Get Involved</a> page.
 It lists information that is required for contributing to StreamPipes.</p>
 <p>When you contribute code, you affirm that the contribution is your original work and that you
 license the work to the project under the project's open source license. Whether or not you
@@ -2448,6 +2448,17 @@ <h2 id="contributing">👨‍💻 Contributing<a class="headerlink" href="#contr
 warrant that you have the legal authority to do so.</p>
 <hr />
 
+  <hr>
+<div class="md-source-file">
+  <small>
+
+      Last update:
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">June 20, 2024</span>
+
+
+  </small>
+</div>
+
 
 
 

diff --git a/docs-python/dev/getting-started/first-steps/index.html b/docs-python/dev/getting-started/first-steps/index.html
@@ -2330,10 +2330,10 @@ <h3 id="start-streampipes-via-docker-compose">🐳 Start StreamPipes via Docker
 ...            ...       ...       ...       ...       ...       ...
 </code></pre></div>
 Otherwise, you need to start docker first.
-Please read the full guide on how to start StreamPipes with <code>docker compose</code> <a href="https://streampipes.apache.org/docs/docs/deploy-docker.html">here</a>.</p>
+Please read the full guide on how to start StreamPipes with <code>docker compose</code> <a href="https://streampipes.apache.org/docs/deploy-docker/">here</a>.</p>
 <h4 id="setup-streampipes-with-nats-as-message-broker">Setup StreamPipes with NATS as message broker<a class="headerlink" href="#setup-streampipes-with-nats-as-message-broker" title="Permanent link">&para;</a></h4>
 <p>The following shows how you can set up a StreamPipes instance that uses <a href="https://docs.nats.io/">NATS</a> as messaging layer.
-So in this scenario, we will go with <code>docker-compose.nats.yml</code>. 
+So in this scenario, we will go with <code>docker-compose.nats.yml</code>.
 Thereby, when running locally, we need to add the following port mapping entry to <code>services.nats.ports</code>:
 <div class="language-yaml highlight"><pre><span></span><code><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">4222:4222</span>
 </code></pre></div></p>
@@ -2357,9 +2357,20 @@ <h4 id="setup-streampipes-with-kafka-as-message-broker">Setup StreamPipes with K
 </code></pre></div></p>
 <p>Once all services are started, you can access StreamPipes via <code>http://localhost</code>.</p>
 <p>In case you want to have more control over your StreamPipes setup,
-you might take a look at our <a href="https://streampipes.apache.org/docs/docs/extend-cli.html">deployment CLI</a>.</p>
+you might take a look at our <a href="https://streampipes.apache.org/docs/extend-cli/">deployment CLI</a>.</p>
 <p>Have fun discovering StreamPipes and our Python library 🚀</p>
 
+  <hr>
+<div class="md-source-file">
+  <small>
+
+      Last update:
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">June 20, 2024</span>
+
+
+  </small>
+</div>
+
 
 
 

diff --git a/docs-python/dev/getting-started/quickstart/index.html b/docs-python/dev/getting-started/quickstart/index.html
@@ -2267,6 +2267,17 @@ <h1 id="quickstart">⚡️ Quickstart<a class="headerlink" href="#quickstart" ti
 The <code>api_key</code> can be generated within the UI as demonstrated below:</p>
 <p><img alt="Howto API Key" src="../../img/how-to-get-api-key.gif" /></p>
 
+  <hr>
+<div class="md-source-file">
+  <small>
+
+      Last update:
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">May 31, 2023</span>
+
+
+  </small>
+</div>
+
 
 
 

diff --git a/docs-python/dev/index.html b/docs-python/dev/index.html
@@ -2326,6 +2326,17 @@ <h2 id="quickstart">⚡️ Quickstart<a class="headerlink" href="#quickstart" ti
 <p><img alt="Howto API Key" src="img/how-to-get-api-key.gif" /></p>
 </details>
 
+  <hr>
+<div class="md-source-file">
+  <small>
+
+      Last update:
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">April 3, 2024</span>
+
+
+  </small>
+</div>
+
 
 
 

diff --git a/docs-python/dev/reference/client/client/index.html b/docs-python/dev/reference/client/client/index.html
@@ -2618,7 +2618,7 @@ <h3 id="streampipes.client.client.StreamPipesClient.http_headers" class="doc doc
           </td>
           <td class="doc-returns-details">
             <div class="doc-md-description">
-              <p>header information for HTTP requests as string key-value pairs.</p>
+              <p>Header information for HTTP requests as string key-value pairs.</p>
             </div>
               <p>
                 <span class="doc-returns-annotation">
@@ -2805,6 +2805,17 @@ <h3 id="streampipes.client.client.StreamPipesClient.describe" class="doc doc-hea
 
 </div>
 
+  <hr>
+<div class="md-source-file">
+  <small>
+
+      Last update:
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">June 22, 2024</span>
+
+
+  </small>
+</div>
+
 
 
 

diff --git a/docs-python/dev/reference/client/config/index.html b/docs-python/dev/reference/client/config/index.html
@@ -2420,6 +2420,17 @@ <h2 id="streampipes.client.config.StreamPipesClientConfig" class="doc doc-headin
 
 </div>
 
+  <hr>
+<div class="md-source-file">
+  <small>
+
+      Last update:
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">June 22, 2024</span>
+
+
+  </small>
+</div>
+
 
 
 

diff --git a/docs-python/dev/reference/client/credential_provider/index.html b/docs-python/dev/reference/client/credential_provider/index.html
@@ -2601,7 +2601,7 @@ <h3 id="streampipes.client.credential_provider.StreamPipesApiKeyCredentials.from
   <div class="doc doc-contents ">
 
       <p>DEPRECATED - use the class constructor instead</p>
-<p>Returns an api key provider parameterized via environment variables.</p>
+<p>Returns an API key provider parameterized via environment variables.</p>
 
 
 
@@ -2798,6 +2798,17 @@ <h3 id="streampipes.client.credential_provider.StreamPipesApiKeyCredentials.make
 
 </div>
 
+  <hr>
+<div class="md-source-file">
+  <small>
+
+      Last update:
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">June 22, 2024</span>
+
+
+  </small>
+</div>
+
 
 
 

diff --git a/docs-python/dev/reference/endpoint/api/data_lake_measure/index.html b/docs-python/dev/reference/endpoint/api/data_lake_measure/index.html
@@ -2552,7 +2552,7 @@ <h3 id="streampipes.endpoint.api.data_lake_measure.DataLakeMeasureEndpoint.all"
           </td>
           <td class="doc-returns-details">
             <div class="doc-md-description">
-              <p>container element that bundles the returned resources</p>
+              <p>Container element that bundles the returned resources</p>
             </div>
               <p>
                 <span class="doc-returns-annotation">
@@ -2663,7 +2663,7 @@ <h3 id="streampipes.endpoint.api.data_lake_measure.DataLakeMeasureEndpoint.get"
           <td><code>**kwargs</code></td>
           <td class="doc-param-details">
             <div class="doc-md-description">
-              <p>keyword arguments can be used to provide additional query parameters.
+              <p>Keyword arguments can be used to provide additional query parameters.
 The available query parameters are defined by the
 <a class="autorefs autorefs-internal" href="#streampipes.endpoint.api.data_lake_measure.MeasurementGetQueryConfig">MeasurementGetQueryConfig</a>.</p>
             </div>
@@ -2698,7 +2698,7 @@ <h3 id="streampipes.endpoint.api.data_lake_measure.DataLakeMeasureEndpoint.get"
           </td>
           <td class="doc-returns-details">
             <div class="doc-md-description">
-              <p>the specified data lake measure</p>
+              <p>The specified data lake measure</p>
             </div>
               <p>
                 <span class="doc-returns-annotation">
@@ -2852,7 +2852,7 @@ <h2 id="streampipes.endpoint.api.data_lake_measure.MeasurementGetQueryConfig" cl
           <td><code><span title="streampipes.endpoint.api.data_lake_measure.MeasurementGetQueryConfig.end_date">end_date</span></code></td>
           <td class="doc-attribute-details">
             <div class="doc-md-description">
-              <p>Restricts queried data to be younger than the specified time.</p>
+              <p>Limits the queried data to only include data that is older than the specified time. In other words, any data that occurred after the end_date will not be included in the query results.</p>
             </div>
             <p>
                 <span class="doc-attribute-annotation">
@@ -2926,7 +2926,7 @@ <h2 id="streampipes.endpoint.api.data_lake_measure.MeasurementGetQueryConfig" cl
           <td><code><span title="streampipes.endpoint.api.data_lake_measure.MeasurementGetQueryConfig.start_date">start_date</span></code></td>
           <td class="doc-attribute-details">
             <div class="doc-md-description">
-              <p>Restricts queried data to be older than the specified time</p>
+              <p>Limits the queried data to only include data that is newer than the specified time. In other words, any data that occurred before the start_date will not be included in the query results.</p>
             </div>
             <p>
                 <span class="doc-attribute-annotation">
@@ -3084,6 +3084,17 @@ <h2 id="streampipes.endpoint.api.data_lake_measure.StreamPipesQueryValidationErr
 
 </div>
 
+  <hr>
+<div class="md-source-file">
+  <small>
+
+      Last update:
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">June 22, 2024</span>
+
+
+  </small>
+</div>
+
 
 
 

diff --git a/docs-python/dev/reference/endpoint/api/data_stream/index.html b/docs-python/dev/reference/endpoint/api/data_stream/index.html
@@ -2442,7 +2442,7 @@ <h3 id="streampipes.endpoint.api.data_stream.DataStreamEndpoint.all" class="doc
           </td>
           <td class="doc-returns-details">
             <div class="doc-md-description">
-              <p>container element that bundles the returned resources</p>
+              <p>Container element that bundles the returned resources</p>
             </div>
               <p>
                 <span class="doc-returns-annotation">
@@ -2671,6 +2671,17 @@ <h3 id="streampipes.endpoint.api.data_stream.DataStreamEndpoint.post" class="doc
 
 </div>
 
+  <hr>
+<div class="md-source-file">
+  <small>
+
+      Last update:
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">June 22, 2024</span>
+
+
+  </small>
+</div>
+
 
 
 

diff --git a/docs-python/dev/reference/endpoint/api/version/index.html b/docs-python/dev/reference/endpoint/api/version/index.html
@@ -2468,7 +2468,7 @@ <h3 id="streampipes.endpoint.api.version.VersionEndpoint.all" class="doc doc-hea
           </td>
           <td class="doc-raises-details">
             <div class="doc-md-description">
-              <p>this endpoint does not return multiple entries, therefore this method is not available</p>
+              <p>This endpoint does not return multiple entries, therefore this method is not available.</p>
             </div>
           </td>
         </tr>
@@ -2662,7 +2662,7 @@ <h3 id="streampipes.endpoint.api.version.VersionEndpoint.post" class="doc doc-he
           </td>
           <td class="doc-raises-details">
             <div class="doc-md-description">
-              <p>this endpoint does not allow for POST requests, therefore this method is not available</p>
+              <p>This endpoint does not allow for POST requests, therefore this method is not available.</p>
             </div>
           </td>
         </tr>
@@ -2691,6 +2691,17 @@ <h3 id="streampipes.endpoint.api.version.VersionEndpoint.post" class="doc doc-he
 
 </div>
 
+  <hr>
+<div class="md-source-file">
+  <small>
+
+      Last update:
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">June 22, 2024</span>
+
+
+  </small>
+</div>
+
 
 
 

diff --git a/docs-python/dev/reference/endpoint/endpoint/index.html b/docs-python/dev/reference/endpoint/endpoint/index.html
@@ -2410,7 +2410,7 @@ <h1>Endpoint</h1>
 
       <p>General implementation for an endpoint.
 Provided classes and assets are aimed to be used for developing endpoints.
-An endpoint provides all options to communicate with ad dedicated part of StreamPipes in a handy way.</p>
+An endpoint provides all options to communicate with a dedicated part of StreamPipes in a handy way.</p>
 
 
 
@@ -2488,7 +2488,7 @@ <h3 id="streampipes.endpoint.endpoint.APIEndpoint.all" class="doc doc-heading">
           </td>
           <td class="doc-returns-details">
             <div class="doc-md-description">
-              <p>container element that bundles the returned resources</p>
+              <p>Container element that bundles the returned resources</p>
             </div>
               <p>
                 <span class="doc-returns-annotation">
@@ -2902,7 +2902,7 @@ <h3 id="streampipes.endpoint.endpoint.MessagingEndpoint.configure" class="doc do
 
       <p>Configures the message endpoint by setting the broker instance to be used.</p>
 <p>This configuration step is required before the endpoint can be actually used.
-The based <code>broker</code> instance is passed to an internal property</p>
+The based <code>broker</code> instance is passed to an internal property.</p>
 
 
 
@@ -2978,6 +2978,17 @@ <h3 id="streampipes.endpoint.endpoint.MessagingEndpoint.configure" class="doc do
 
 </div>
 
+  <hr>
+<div class="md-source-file">
+  <small>
+
+      Last update:
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">June 22, 2024</span>
+
+
+  </small>
+</div>
+
 
 
 

diff --git a/docs-python/dev/reference/endpoint/exceptions/index.html b/docs-python/dev/reference/endpoint/exceptions/index.html
@@ -2272,7 +2272,7 @@ <h1>Exceptions</h1>
 <a id="streampipes.endpoint.exceptions"></a>
   <div class="doc doc-contents first">
 
-      <p>Custom exceptions dedicated for the endpoints module</p>
+      <p>Custom exceptions dedicated to the endpoints module.</p>
 
 
 
@@ -2362,6 +2362,17 @@ <h2 id="streampipes.endpoint.exceptions.MessagingEndpointNotConfiguredError" cla
 
 </div>
 
+  <hr>
+<div class="md-source-file">
+  <small>
+
+      Last update:
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">June 22, 2024</span>
+
+
+  </small>
+</div>
+