Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Python SDK documentation #168

Merged
merged 2 commits into from
Dec 8, 2023
Merged

Update Python SDK documentation #168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1681e58
docs: Update Python SDK API documentation to match `main`
pniedzielski Dec 7, 2023
a4f0327
docs: Teach Jekyll to ignore fewer Python API docs
pniedzielski Dec 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion docs/_config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,20 @@ exclude:
# theme test code
- fixtures/

# Jekyll ignores files whose name begins with an underscore by default, yet the
# Python SDK API documentation generated by Sphinx creates many of these. We
# have to explicitly include each such file here or it will not be copied into
# the GitHub Pages.
include:
- _static
- _modules
- _sources
- _sphinx_javascript_frameworks_compat.js # Required for the Python SDK API documentation
- _sphinx_javascript_frameworks_compat.js
- _enums.html
- _messages.html
- _monitors.html
- _session.html
- _timeouts.html

# Set a path/url to a logo that will be displayed instead of the title
logo: "/assets/images/Asset [email protected]"
Expand Down
28 changes: 14 additions & 14 deletions docs/docs/apidocs/python_apidocs/BUILD.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Build instructions for the BlazingMQ Python SDK &mdash; blazingmq 1.2.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />


<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
Expand Down Expand Up @@ -110,19 +112,17 @@ <h2>Using <code class="docutils literal notranslate"><span class="pre">make</spa
</section>
<section id="local-development">
<h2>Local Development<a class="headerlink" href="#local-development" title="Link to this heading"></a></h2>
<p>The BlazingMQ C++ SDK provides a <code class="docutils literal notranslate"><span class="pre">./build-manylinux.sh</span></code> script and a
`./build-macosx-universal.sh‘ script for setting up a
development environmen.</p>
<p>The BlazingMQ Python SDK provides a <code class="docutils literal notranslate"><span class="pre">./build-manylinux.sh</span></code> script and a
<code class="docutils literal notranslate"><span class="pre">./build-macosx-universal.sh</span></code> script for setting up a development environment.</p>
</section>
<section id="working-with-make-targets">
<h2>Working with Make Targets<a class="headerlink" href="#working-with-make-targets" title="Link to this heading"></a></h2>
<p>When in an interactive command line prompt, you can use the following
<code class="docutils literal notranslate"><span class="pre">make</span></code> targets to build and test the BlazingMQ Python SDK. Check the
GitHub Actions configuration to set up the appropriate environment
variables that may be needed prior to running these commands (such as
setting <code class="docutils literal notranslate"><span class="pre">PYEXEC</span></code>). With a BlazingMQ broker running at
‘tcp://localhost:30114‘, the following targets build and test the
Python SDK:</p>
<p>When in an interactive command line prompt, you can use the following <code class="docutils literal notranslate"><span class="pre">make</span></code>
targets to build and test the BlazingMQ Python SDK. Check the
appropriate GitHub Actions configuration to set up the appropriate environment
variables that may be needed prior to running these commands (such as setting
<code class="docutils literal notranslate"><span class="pre">PYEXEC</span></code>). With a BlazingMQ broker running at <code class="docutils literal notranslate"><span class="pre">tcp://localhost:30114</span></code>, the
following targets build and test the Python SDK:</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>make<span class="w"> </span>test-install
<span class="nv">BMQ_BROKER_URI</span><span class="o">=</span>tcp://localhost:30114<span class="w"> </span>make<span class="w"> </span>check
</pre></div>
Expand Down
10 changes: 6 additions & 4 deletions docs/docs/apidocs/python_apidocs/CHANGELOG.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Changelog &mdash; blazingmq 1.2.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />


<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
Expand Down
8 changes: 5 additions & 3 deletions docs/docs/apidocs/python_apidocs/_modules/blazingmq/_enums.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html5" lang="en" data-content_root="../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>blazingmq._enums &mdash; blazingmq 1.2.0 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />


<!--[if lt IE 9]>
<script src="../../_static/js/html5shiv.min.js"></script>
<![endif]-->
Expand Down
8 changes: 5 additions & 3 deletions docs/docs/apidocs/python_apidocs/_modules/blazingmq/_messages.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html5" lang="en" data-content_root="../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>blazingmq._messages &mdash; blazingmq 1.2.0 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />


<!--[if lt IE 9]>
<script src="../../_static/js/html5shiv.min.js"></script>
<![endif]-->
Expand Down
8 changes: 5 additions & 3 deletions docs/docs/apidocs/python_apidocs/_modules/blazingmq/_monitors.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html5" lang="en" data-content_root="../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>blazingmq._monitors &mdash; blazingmq 1.2.0 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />


<!--[if lt IE 9]>
<script src="../../_static/js/html5shiv.min.js"></script>
<![endif]-->
Expand Down
Loading
Loading