Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ __pycache__/
!p.so
!libq.*
!q.*
!qdll.*
!libe.so
!e.*
!libkurl.*
Expand Down
18 changes: 14 additions & 4 deletions MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,35 @@ graft src/pykx/lib
graft src/pykx/extensions

recursive-include src/pykx *.py *.pxd *.pyx *.c *.so *.k
recursive-include tests *.py

include src/pykx/pykx.q
include src/pykx/pykx_init.q_

# When adding to this list a user should be conscious
# to additionally update the ignore pattern files in
# build/github.py
# Keep internal-only content out of the package. This list must be kept
# aligned with the ignore patterns in scripts/github.py, which keep the same
# content out of the public GitHub source repo - when adding to either list,
# update the other. Note the two use different matching: scripts/github.py
# matches by base name recursively at any depth, whereas MANIFEST.in matches
# anchored paths, so the entries below will not always look identical.
exclude **/.gitignore
exclude .gitlab-ci.yml
exclude mkdocs.yml
exclude **/pykx_init.q
exclude sonar-project.properties
global-exclude *.whl

prune build
prune coverage
prune docs
prune benchmarks
prune examples
prune tests
prune scripts
prune .gitlab
prune notebooks
prune docs_setup
prune docs_archive
prune _docker

include docs/api/pykx-execution/q.md

10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,11 @@ Full instructions on license installation are covered on the [Installing page](d

KX only officially supports versions of KDB-X Python built by KX, i.e. versions of KDB-X Python installed from wheel files. Support for user-built installations of KDB-X Python (e.g. built from the source distribution) is only provided on a best-effort basis. Currently, KDB-X Python provides wheels for the following environments:

- Linux (`manylinux2014_x86_64`, `manylinux2014_aarch64`) with CPython 3.9-3.14
- macOS (`macosx_10_15_x86_64`, `macosx_10_15_arm64`) with CPython 3.9-3.14
- Windows (`win_amd64`) with CPython 3.9-3.14
- **Linux**
- (`manylinux2014_x86_64`, `manylinux2014_aarch64`) with CPython 3.9-3.11
- (`manylinux_2_28_x86_64`, `manylinux_2_28_aarch64`) with CPython 3.12-3.14
- **macOS** (`macosx_10_15_x86_64`, `macosx_10_15_arm64`) with CPython 3.9-3.14
- **Windows** (`win_amd64`) with CPython 3.9-3.14

### Dependencies

Expand Down Expand Up @@ -185,7 +187,7 @@ This work is dual licensed under [Apache 2.0](https://code.kx.com/pykx/license.h

## Community Help

If you have any issues or questions you can post them to [community.kx.com](https://community.kx.com/). Also available on Stack Overflow are the tags [pykx](https://stackoverflow.com/questions/tagged/pykx) and [kdb](https://stackoverflow.com/questions/tagged/kdb).
If you have any issues or questions you can post them to the [KX Forum](https://forum.kx.com/). Also available on Stack Overflow are the tags [pykx](https://stackoverflow.com/questions/tagged/pykx) and [kdb](https://stackoverflow.com/questions/tagged/kdb).

## Customer Support

Expand Down
11 changes: 0 additions & 11 deletions custom_theme/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,4 @@
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','GTM-PG938LS');</script>
<!-- End Google Tag Manager -->
<!-- Delighted Survey tool -->
<script type="text/javascript">
!function(e,t,r,n){if(!e[n]){for(var a=e[n]=[],i=["survey","reset","config","init","set","get","event","identify","track","page","screen","group","alias"],s=0;s<i.length;s++){var c=i[s];a[c]=a[c]||function(e){return function(){var t=Array.prototype.slice.call(arguments);a.push([e,t])}}(c)}a.SNIPPET_VERSION="1.0.1";var o=t.createElement("script");o.type="text/javascript",o.async=!0,o.src="https://d2yyd1h5u9mauk.cloudfront.net/integrations/web/v1/library/"+r+"/"+n+".js";var p=t.getElementsByTagName("script")[0];p.parentNode.insertBefore(o,p)}}(window,document,"QKBtsIp633c7g2I2","delightedThumbsP");

delightedThumbsP.survey({
properties: { // extra context (optional)
product: "KDB-X Python"
}
});
</script>
<!-- End Delighted Survey tool -->
{% endblock %}
45 changes: 14 additions & 31 deletions custom_theme/partials/header.html.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,11 @@
var currVersion = '{{ config.curr_docs_version }}'
</script>
<style>
/* mkdocs-material 9.7.6 no longer sets position:relative on
.md-version, so the absolutely-positioned list anchored to a
wide ancestor and the old "margin-top: 20%" hack dropped it
into the page. Re-anchor it directly under the version button. */
.md-version { position: relative; }
.md-version:focus-within .md-version__list, .md-version:hover .md-version__list {
max-height: 6rem;
opacity: 1;
Expand All @@ -33,7 +38,7 @@
</style>
<div class="md-version">
<button class="md-version__current" aria-label="Select version">{{ config.curr_docs_version }}</button>
<ul class="md-version__list" style="margin-top: 20%;">
<ul class="md-version__list" style="margin-top: 2.2rem;">
<div id="versionList"></div>
</ul>
</div>
Expand Down Expand Up @@ -85,11 +90,14 @@
</div>
</div>
{% endif %}
{% if "search" in config["plugins"] %}
<label class="md-header__button md-icon" for="__search">
{% include ".icons/material/magnify.svg" %}
</label>
{% include "partials/search.html" %}
{% if "material/search" in config.plugins %}
{% set search = config.plugins["material/search"] | attr("config") %}
{% if search.enabled %}
<label class="md-header__button md-icon" for="__search">
{% include ".icons/material/magnify.svg" %}
</label>
{% include "partials/search.html" %}
{% endif %}
{% endif %}
{% if config.repo_url %}
<div class="md-header__source">
Expand All @@ -103,28 +111,3 @@
{% endif %}
{% endif %}
</header>
<style>
@media (max-width: 430px) {
.md-typeset span{display:none;}
}
/* Button used to open the chat form - fixed at the bottom of the page */
.open-button {
background-color: var(--md-typeset-a-color);
border: none;
border-radius: 10px;
bottom: 23px;
box-sizing: border-box;
color: var(--md-default-bg-color);
cursor: pointer;
font-size: 13px;
opacity: 0.8;
padding: 10px 10px;
position: fixed;
right: 28px;
width: 160px;
z-index: 3;
}
</style>
<body>
<button class="open-button md-typeset" onclick="window.location.href='https://kx.com/slack'"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M256 32C114.6 32 0 125.1 0 240c0 47.6 19.9 91.2 52.9 126.3C38 405.7 7 439.1 6.5 439.5c-6.6 7-8.4 17.2-4.6 26S14.4 480 24 480c61.5 0 110-25.7 139.1-46.3C192 442.8 223.2 448 256 448c141.4 0 256-93.1 256-208S397.4 32 256 32zm0 368c-26.7 0-53.1-4.1-78.4-12.1l-22.7-7.2-19.5 13.8c-14.3 10.1-33.9 21.4-57.5 29 7.3-12.1 14.4-25.7 19.9-40.2l10.6-28.1-20.6-21.8C69.7 314.1 48 282.2 48 240c0-88.2 93.3-160 208-160s208 71.8 208 160-93.3 160-208 160z"></path></svg></span>&nbsp;Ask a question</button>
</body>
83 changes: 83 additions & 0 deletions docs/404.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
title: Page not found
description: The requested KDB-X Python documentation page could not be found.
hide:
- navigation
- toc
search:
exclude: true
---

<div class="not-found-page">
<section class="not-found-hero" aria-labelledby="not-found-title">
<div
class="not-found-illustration"
role="img"
aria-label="An interrupted Python code path across a data grid"
></div>
<div class="not-found-copy">
<h1 id="not-found-title">404: Page not found</h1>
<p class="not-found-lead">
Don't worry – even the best Python code sometimes raises an exception.
This page may have moved, been renamed, or become unavailable.
</p>
<div class="not-found-actions">
<a class="md-button md-button--primary" href="https://code.kx.com/pykx/">
KDB-X Python Documentation Home
</a>
</div>
</div>
</section>

<div class="not-found-lower">
<section class="not-found-destinations" aria-labelledby="not-found-destinations-title">
<h2 id="not-found-destinations-title">Find your way</h2>
<p class="not-found-destinations-intro">
Use the site search above, or choose a KDB-X Python documentation area.
</p>
<div class="not-found-card-grid">
<a class="not-found-card" href="https://code.kx.com/pykx/getting-started/installing.html">
<span class="not-found-card-title">Install KDB-X Python</span>
</a>
<a class="not-found-card" href="https://code.kx.com/pykx/getting-started/quickstart.html">
<span class="not-found-card-title">Quickstart</span>
</a>
<a class="not-found-card" href="https://code.kx.com/pykx/examples/interface-overview.html">
<span class="not-found-card-title">Fundamentals</span>
</a>
<a class="not-found-card" href="https://code.kx.com/pykx/user-guide/fundamentals/query/index.html">
<span class="not-found-card-title">Query Data</span>
</a>
<a class="not-found-card" href="https://code.kx.com/pykx/api/pykx-execution/q.html">
<span class="not-found-card-title">API Reference</span>
</a>
<a class="not-found-card" href="https://code.kx.com/pykx/upgrades/3040.html">
<span class="not-found-card-title">Migrate from PyKX 3.x</span>
</a>
</div>
</section>

<section
class="not-found-support"
aria-label="Documentation feedback, community, and customer support"
>
<div class="not-found-support-group">
<h2>Documentation feedback</h2>
<a href="mailto:docs@kx.com?subject=Broken%20KDB-X%20Python%20documentation%20link">
Report a broken link
</a>
</div>
<div class="not-found-support-group">
<h2>Community</h2>
<div class="not-found-support-links">
<a href="https://forum.kx.com/">KX Community Forum</a>
<a href="https://kx.com/slack">KX Slack Community</a>
</div>
</div>
<div class="not-found-support-group">
<h2>Customer support</h2>
<a href="https://kx.com/software-support">KX Support Portal</a>
</div>
</section>
</div>
</div>
Loading
Loading