forked from hablapps/pykx
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
235 lines (223 loc) · 8.24 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
---
site_name: 'PyKX'
site_author: 'KX'
site_description: 'PyKX Documentation'
site_url: 'https://code.kx.com/pykx'
copyright: 'Ⓒ KX 2022'
site_dir: 'public'
dev_addr: 'localhost:8080'
use_directory_urls: false
# Keep commented out until PyKX is open-source
repo_url: 'https://github.com/kxsystems/pykx'
edit_uri: 'edit/main/docs/'
extra_css:
- https://code.kx.com/assets/stylesheets/main.b941530a.min.css
- https://code.kx.com/stylesheets/2021.css
- https://code.kx.com/stylesheets/prism.css
- https://code.kx.com/stylesheets/extra.css
- https://code.kx.com/stylesheets/hide-footer-nav.css
- stylesheets/mkdocstrings.css
- https://code.kx.com/stylesheets/dashboards.css
- https://code.kx.com/dashboards/stylesheets/dashboards.css
- stylesheets/swagger.css
extra_javascript:
- https://code.kx.com/scripts/prism.js
- https://code.kx.com/scripts/extra.js
- https://code.kx.com/scripts/mathjax.js
- https://code.kx.com/scripts/polyfill.min.js
- https://code.kx.com/scripts/tex-mmmdtml.js
- 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-MML-AM_CHTML'
- 'https://code.jquery.com/jquery-3.6.0.min.js'
- 'https://use.fontawesome.com/3dbf29ed12.js'
# this relative path is needed to source from code.kx.com!!!
- "../../pykx/scripts/versions.js"
# Uncomment only for local test
# - 'scripts/versions.js'
markdown_extensions:
- abbr
- admonition
- attr_list
- md_in_html
- extra
- def_list
- meta
- tables
- markdown_grid_tables
- pymdownx.arithmatex:
generic: true
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
options:
custom_icons:
- custom_theme/.icons
- pymdownx.tabbed:
alternate_style: true
- pymdownx.extra
- pymdownx.highlight:
use_pygments: false
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tilde
- toc:
permalink: false
title: On this page
plugins:
- autorefs
- mkdocs-jupyter:
execute: True
include: ["*.ipynb"]
include_source: True # Let users download the Jupyter notebook to use interactively
allow_errors: False
- exclude:
glob:
- internal/*
- mkdocstrings:
handlers:
python:
rendering:
docstring_section_style: 'table'
heading_level: 2
line_length: 80
members_order: 'source'
merge_init_into_class: true
separate_signature: true
show_bases: true
show_if_no_docstring: false
show_object_full_path: false
show_root_full_path: true
show_root_heading: true
show_root_toc_entry: true
show_signature: true
show_source: false
show_submodules: false
import:
- https://docs.python.org/3/objects.inv
- https://numpy.org/doc/stable/objects.inv
- https://pandas.pydata.org/docs/objects.inv
- render_swagger
- search
- spellcheck:
known_words: spelling.txt
ignore_code: true # Ignore words in <code> tags
min_length: 2 # Minimum length of words to consider
# max_capital: 1 # Maximum number of capital letters in a word
allow_unicode: false # Keep unicode characters
skip_files: # Skip files entirely
- comparisons.md # Skipped due to false positives
- performance.md # Skipped due to false positives
- getting-started/interface_overview.ipynb
- getting-started/q_magic_command.ipynb
- user-guide/advanced/Pandas_API.ipynb
theme:
name: material
custom_dir: custom_theme/
favicon: https://code.kx.com/favicon.ico
font: false
icon:
repo: fontawesome/brands/git-alt
edit: material/pencil
view: material/eye
features:
- content.tabs.link # Insiders
- header.autohide
- navigation.tabs
- content.code.annotate
- content.action.edit
palette:
- media: "(prefers-color-scheme: light)"
scheme: kx-light
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/toggle-switch
name: Switch to light mode
language: en
docs_dir: docs
nav:
- Home: 'https://code.kx.com/insights/'
- kdb+ and q: 'https://code.kx.com/q'
- kdb Insights: "https://code.kx.com/insights/core"
- kdb Insights Enterprise: "https://code.kx.com/insights/platform/"
- Licensing : "https://code.kx.com/insights/licensing/licensing/"
- PyKX:
- index.md
- Getting Started:
- What is PyKX?: getting-started/what_is_pykx.md
- Installation: getting-started/installing.md
- Quickstart guide: getting-started/quickstart.md
- Notebook Example: getting-started/interface_overview.ipynb
- Jupyter q Magic Command: getting-started/q_magic_command.ipynb
- User Guide:
- Introduction: user-guide/index.md
- Configuration: user-guide/configuration.md
- Fundamentals:
- Generating PyKX objects: user-guide/fundamentals/creating.md
- Interacting with PyKX objects: user-guide/fundamentals/evaluating.md
- Querying data: user-guide/fundamentals/querying.md
- Indexing PyKX objects: user-guide/fundamentals/indexing.md
- Text Representation in PyKX: user-guide/fundamentals/text.md
- Handling nulls and infinities: user-guide/fundamentals/nulls_and_infinities.md
- Advanced usage and performance considerations:
- Communicating via IPC: user-guide/advanced/ipc.md
- Using q functions in a Pythonic way: user-guide/advanced/context_interface.md
- Modes of operation: user-guide/advanced/modes.md
- Numpy integration: user-guide/advanced/numpy.md
- Serialization and de-serialization: user-guide/advanced/serialization.md
- Performance considerations: user-guide/advanced/performance.md
- Interface limitations: user-guide/advanced/limitations.md
- Pandas API: user-guide/advanced/Pandas_API.ipynb
- Attributes: user-guide/advanced/attributes.md
- API:
- Code execution:
- PyKX native functions: api/pykx-execution/q.md
- PyKX execution classes: api/pykx-execution/embedded_q.md
- Context interface: api/pykx-execution/ctx.md
- PyKX console: api/pykx-execution/console.md
- Data types and conversions:
- Convert Pythonic data to PyKX: api/pykx-q-data/toq.md
- PyKX type wrappers: api/pykx-q-data/wrappers.md
- PyKX to Pythonic data type mapping: api/pykx-q-data/type_conversions.md
- Registering Custom Conversions: api/pykx-q-data/register.md
- License management: api/license.md
- Random data generation: api/random.md
- Querying: api/query.md
- IPC: api/ipc.md
- PyKX Exceptions: api/exceptions.md
- Schema generation: api/schema.md
- File loading and saving:
- Writing PyKX data to disk: api/pykx-save-load/write.md
- Reading PyKX data from disk: api/pykx-save-load/read.md
- Reimporter module: api/reimporting.md
- Serialization: api/serialize.md
- Examples:
- Subscriber: examples/subscriber/readme.md
- Compression and Encryption: examples/compress_and_encrypt/readme.md
- IPC: examples/ipc/README.md
- PyKX as a Server: examples/server/server.md
- Multithreaded Execution: examples/threaded_execution/README.md
- Extras:
- Comparisons against other Python/q interfaces: extras/comparisons.md
- Known issues: extras/known_issues.md
- Python interfacing within q:
- Overview: pykx-under-q/intro.md
- API: pykx-under-q/api.md
- Upgrading from embedPy: pykx-under-q/upgrade.md
- Release notes:
- PyKX: release-notes/changelog.md
- PyKX under q: release-notes/underq-changelog.md
- Roadmap: roadmap.md
- Troubleshooting: troubleshooting.md
- Frequently Asked Questions (FAQ): faq.md
- Support: support.md
- License: license.md