pybiolib 0.2.951__py3-none-any.whl → 1.2.1890__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (262) hide show
  1. biolib/__init__.py +357 -11
  2. biolib/_data_record/data_record.py +380 -0
  3. biolib/_index/__init__.py +0 -0
  4. biolib/_index/index.py +55 -0
  5. biolib/_index/query_result.py +103 -0
  6. biolib/_internal/__init__.py +0 -0
  7. biolib/_internal/add_copilot_prompts.py +58 -0
  8. biolib/_internal/add_gui_files.py +81 -0
  9. biolib/_internal/data_record/__init__.py +1 -0
  10. biolib/_internal/data_record/data_record.py +85 -0
  11. biolib/_internal/data_record/push_data.py +116 -0
  12. biolib/_internal/data_record/remote_storage_endpoint.py +43 -0
  13. biolib/_internal/errors.py +5 -0
  14. biolib/_internal/file_utils.py +125 -0
  15. biolib/_internal/fuse_mount/__init__.py +1 -0
  16. biolib/_internal/fuse_mount/experiment_fuse_mount.py +209 -0
  17. biolib/_internal/http_client.py +159 -0
  18. biolib/_internal/lfs/__init__.py +1 -0
  19. biolib/_internal/lfs/cache.py +51 -0
  20. biolib/_internal/libs/__init__.py +1 -0
  21. biolib/_internal/libs/fusepy/__init__.py +1257 -0
  22. biolib/_internal/push_application.py +488 -0
  23. biolib/_internal/runtime.py +22 -0
  24. biolib/_internal/string_utils.py +13 -0
  25. biolib/_internal/templates/__init__.py +1 -0
  26. biolib/_internal/templates/copilot_template/.github/instructions/general-app-knowledge.instructions.md +10 -0
  27. biolib/_internal/templates/copilot_template/.github/instructions/style-general.instructions.md +20 -0
  28. biolib/_internal/templates/copilot_template/.github/instructions/style-python.instructions.md +16 -0
  29. biolib/_internal/templates/copilot_template/.github/instructions/style-react-ts.instructions.md +47 -0
  30. biolib/_internal/templates/copilot_template/.github/prompts/biolib_app_inputs.prompt.md +11 -0
  31. biolib/_internal/templates/copilot_template/.github/prompts/biolib_onboard_repo.prompt.md +19 -0
  32. biolib/_internal/templates/copilot_template/.github/prompts/biolib_run_apps.prompt.md +12 -0
  33. biolib/_internal/templates/dashboard_template/.biolib/config.yml +5 -0
  34. biolib/_internal/templates/github_workflow_template/.github/workflows/biolib.yml +21 -0
  35. biolib/_internal/templates/gitignore_template/.gitignore +10 -0
  36. biolib/_internal/templates/gui_template/.yarnrc.yml +1 -0
  37. biolib/_internal/templates/gui_template/App.tsx +53 -0
  38. biolib/_internal/templates/gui_template/Dockerfile +27 -0
  39. biolib/_internal/templates/gui_template/biolib-sdk.ts +82 -0
  40. biolib/_internal/templates/gui_template/dev-data/output.json +7 -0
  41. biolib/_internal/templates/gui_template/index.css +5 -0
  42. biolib/_internal/templates/gui_template/index.html +13 -0
  43. biolib/_internal/templates/gui_template/index.tsx +10 -0
  44. biolib/_internal/templates/gui_template/package.json +27 -0
  45. biolib/_internal/templates/gui_template/tsconfig.json +24 -0
  46. biolib/_internal/templates/gui_template/vite-plugin-dev-data.ts +50 -0
  47. biolib/_internal/templates/gui_template/vite.config.mts +10 -0
  48. biolib/_internal/templates/init_template/.biolib/config.yml +19 -0
  49. biolib/_internal/templates/init_template/Dockerfile +14 -0
  50. biolib/_internal/templates/init_template/requirements.txt +1 -0
  51. biolib/_internal/templates/init_template/run.py +12 -0
  52. biolib/_internal/templates/init_template/run.sh +4 -0
  53. biolib/_internal/templates/templates.py +25 -0
  54. biolib/_internal/tree_utils.py +106 -0
  55. biolib/_internal/utils/__init__.py +65 -0
  56. biolib/_internal/utils/auth.py +46 -0
  57. biolib/_internal/utils/job_url.py +33 -0
  58. biolib/_internal/utils/multinode.py +263 -0
  59. biolib/_runtime/runtime.py +157 -0
  60. biolib/_session/session.py +44 -0
  61. biolib/_shared/__init__.py +0 -0
  62. biolib/_shared/types/__init__.py +74 -0
  63. biolib/_shared/types/account.py +12 -0
  64. biolib/_shared/types/account_member.py +8 -0
  65. biolib/_shared/types/app.py +9 -0
  66. biolib/_shared/types/data_record.py +40 -0
  67. biolib/_shared/types/experiment.py +32 -0
  68. biolib/_shared/types/file_node.py +17 -0
  69. biolib/_shared/types/push.py +6 -0
  70. biolib/_shared/types/resource.py +37 -0
  71. biolib/_shared/types/resource_deploy_key.py +11 -0
  72. biolib/_shared/types/resource_permission.py +14 -0
  73. biolib/_shared/types/resource_version.py +19 -0
  74. biolib/_shared/types/result.py +14 -0
  75. biolib/_shared/types/typing.py +10 -0
  76. biolib/_shared/types/user.py +19 -0
  77. biolib/_shared/utils/__init__.py +7 -0
  78. biolib/_shared/utils/resource_uri.py +75 -0
  79. biolib/api/__init__.py +6 -0
  80. biolib/api/client.py +168 -0
  81. biolib/app/app.py +252 -49
  82. biolib/app/search_apps.py +45 -0
  83. biolib/biolib_api_client/api_client.py +126 -31
  84. biolib/biolib_api_client/app_types.py +24 -4
  85. biolib/biolib_api_client/auth.py +31 -8
  86. biolib/biolib_api_client/biolib_app_api.py +147 -52
  87. biolib/biolib_api_client/biolib_job_api.py +161 -141
  88. biolib/biolib_api_client/job_types.py +21 -5
  89. biolib/biolib_api_client/lfs_types.py +7 -23
  90. biolib/biolib_api_client/user_state.py +56 -0
  91. biolib/biolib_binary_format/__init__.py +1 -4
  92. biolib/biolib_binary_format/file_in_container.py +105 -0
  93. biolib/biolib_binary_format/module_input.py +24 -7
  94. biolib/biolib_binary_format/module_output_v2.py +149 -0
  95. biolib/biolib_binary_format/remote_endpoints.py +34 -0
  96. biolib/biolib_binary_format/remote_stream_seeker.py +59 -0
  97. biolib/biolib_binary_format/saved_job.py +3 -2
  98. biolib/biolib_binary_format/{attestation_document.py → stdout_and_stderr.py} +8 -8
  99. biolib/biolib_binary_format/system_status_update.py +3 -2
  100. biolib/biolib_binary_format/utils.py +175 -0
  101. biolib/biolib_docker_client/__init__.py +11 -2
  102. biolib/biolib_errors.py +36 -0
  103. biolib/biolib_logging.py +27 -10
  104. biolib/cli/__init__.py +38 -0
  105. biolib/cli/auth.py +46 -0
  106. biolib/cli/data_record.py +164 -0
  107. biolib/cli/index.py +32 -0
  108. biolib/cli/init.py +421 -0
  109. biolib/cli/lfs.py +101 -0
  110. biolib/cli/push.py +50 -0
  111. biolib/cli/run.py +63 -0
  112. biolib/cli/runtime.py +14 -0
  113. biolib/cli/sdk.py +16 -0
  114. biolib/cli/start.py +56 -0
  115. biolib/compute_node/cloud_utils/cloud_utils.py +110 -161
  116. biolib/compute_node/job_worker/cache_state.py +66 -88
  117. biolib/compute_node/job_worker/cache_types.py +1 -6
  118. biolib/compute_node/job_worker/docker_image_cache.py +112 -37
  119. biolib/compute_node/job_worker/executors/__init__.py +0 -3
  120. biolib/compute_node/job_worker/executors/docker_executor.py +532 -199
  121. biolib/compute_node/job_worker/executors/docker_types.py +9 -1
  122. biolib/compute_node/job_worker/executors/types.py +19 -9
  123. biolib/compute_node/job_worker/job_legacy_input_wait_timeout_thread.py +30 -0
  124. biolib/compute_node/job_worker/job_max_runtime_timer_thread.py +3 -5
  125. biolib/compute_node/job_worker/job_storage.py +108 -0
  126. biolib/compute_node/job_worker/job_worker.py +397 -212
  127. biolib/compute_node/job_worker/large_file_system.py +87 -38
  128. biolib/compute_node/job_worker/network_alloc.py +99 -0
  129. biolib/compute_node/job_worker/network_buffer.py +240 -0
  130. biolib/compute_node/job_worker/utilization_reporter_thread.py +197 -0
  131. biolib/compute_node/job_worker/utils.py +9 -24
  132. biolib/compute_node/remote_host_proxy.py +400 -98
  133. biolib/compute_node/utils.py +31 -9
  134. biolib/compute_node/webserver/compute_node_results_proxy.py +189 -0
  135. biolib/compute_node/webserver/proxy_utils.py +28 -0
  136. biolib/compute_node/webserver/webserver.py +130 -44
  137. biolib/compute_node/webserver/webserver_types.py +2 -6
  138. biolib/compute_node/webserver/webserver_utils.py +77 -12
  139. biolib/compute_node/webserver/worker_thread.py +183 -42
  140. biolib/experiments/__init__.py +0 -0
  141. biolib/experiments/experiment.py +356 -0
  142. biolib/jobs/__init__.py +1 -0
  143. biolib/jobs/job.py +741 -0
  144. biolib/jobs/job_result.py +185 -0
  145. biolib/jobs/types.py +50 -0
  146. biolib/py.typed +0 -0
  147. biolib/runtime/__init__.py +14 -0
  148. biolib/sdk/__init__.py +91 -0
  149. biolib/tables.py +34 -0
  150. biolib/typing_utils.py +2 -7
  151. biolib/user/__init__.py +1 -0
  152. biolib/user/sign_in.py +54 -0
  153. biolib/utils/__init__.py +162 -0
  154. biolib/utils/cache_state.py +94 -0
  155. biolib/utils/multipart_uploader.py +194 -0
  156. biolib/utils/seq_util.py +150 -0
  157. biolib/utils/zip/remote_zip.py +640 -0
  158. pybiolib-1.2.1890.dist-info/METADATA +41 -0
  159. pybiolib-1.2.1890.dist-info/RECORD +177 -0
  160. {pybiolib-0.2.951.dist-info → pybiolib-1.2.1890.dist-info}/WHEEL +1 -1
  161. pybiolib-1.2.1890.dist-info/entry_points.txt +2 -0
  162. README.md +0 -17
  163. biolib/app/app_result.py +0 -68
  164. biolib/app/utils.py +0 -62
  165. biolib/biolib-js/0-biolib.worker.js +0 -1
  166. biolib/biolib-js/1-biolib.worker.js +0 -1
  167. biolib/biolib-js/2-biolib.worker.js +0 -1
  168. biolib/biolib-js/3-biolib.worker.js +0 -1
  169. biolib/biolib-js/4-biolib.worker.js +0 -1
  170. biolib/biolib-js/5-biolib.worker.js +0 -1
  171. biolib/biolib-js/6-biolib.worker.js +0 -1
  172. biolib/biolib-js/index.html +0 -10
  173. biolib/biolib-js/main-biolib.js +0 -1
  174. biolib/biolib_api_client/biolib_account_api.py +0 -21
  175. biolib/biolib_api_client/biolib_large_file_system_api.py +0 -108
  176. biolib/biolib_binary_format/aes_encrypted_package.py +0 -42
  177. biolib/biolib_binary_format/module_output.py +0 -58
  178. biolib/biolib_binary_format/rsa_encrypted_aes_package.py +0 -57
  179. biolib/biolib_push.py +0 -114
  180. biolib/cli.py +0 -203
  181. biolib/cli_utils.py +0 -273
  182. biolib/compute_node/cloud_utils/enclave_parent_types.py +0 -7
  183. biolib/compute_node/enclave/__init__.py +0 -2
  184. biolib/compute_node/enclave/enclave_remote_hosts.py +0 -53
  185. biolib/compute_node/enclave/nitro_secure_module_utils.py +0 -64
  186. biolib/compute_node/job_worker/executors/base_executor.py +0 -18
  187. biolib/compute_node/job_worker/executors/pyppeteer_executor.py +0 -173
  188. biolib/compute_node/job_worker/executors/remote/__init__.py +0 -1
  189. biolib/compute_node/job_worker/executors/remote/nitro_enclave_utils.py +0 -81
  190. biolib/compute_node/job_worker/executors/remote/remote_executor.py +0 -51
  191. biolib/lfs.py +0 -196
  192. biolib/pyppeteer/.circleci/config.yml +0 -100
  193. biolib/pyppeteer/.coveragerc +0 -3
  194. biolib/pyppeteer/.gitignore +0 -89
  195. biolib/pyppeteer/.pre-commit-config.yaml +0 -28
  196. biolib/pyppeteer/CHANGES.md +0 -253
  197. biolib/pyppeteer/CONTRIBUTING.md +0 -26
  198. biolib/pyppeteer/LICENSE +0 -12
  199. biolib/pyppeteer/README.md +0 -137
  200. biolib/pyppeteer/docs/Makefile +0 -177
  201. biolib/pyppeteer/docs/_static/custom.css +0 -28
  202. biolib/pyppeteer/docs/_templates/layout.html +0 -10
  203. biolib/pyppeteer/docs/changes.md +0 -1
  204. biolib/pyppeteer/docs/conf.py +0 -299
  205. biolib/pyppeteer/docs/index.md +0 -21
  206. biolib/pyppeteer/docs/make.bat +0 -242
  207. biolib/pyppeteer/docs/reference.md +0 -211
  208. biolib/pyppeteer/docs/server.py +0 -60
  209. biolib/pyppeteer/poetry.lock +0 -1699
  210. biolib/pyppeteer/pyppeteer/__init__.py +0 -135
  211. biolib/pyppeteer/pyppeteer/accessibility.py +0 -286
  212. biolib/pyppeteer/pyppeteer/browser.py +0 -401
  213. biolib/pyppeteer/pyppeteer/browser_fetcher.py +0 -194
  214. biolib/pyppeteer/pyppeteer/command.py +0 -22
  215. biolib/pyppeteer/pyppeteer/connection/__init__.py +0 -242
  216. biolib/pyppeteer/pyppeteer/connection/cdpsession.py +0 -101
  217. biolib/pyppeteer/pyppeteer/coverage.py +0 -346
  218. biolib/pyppeteer/pyppeteer/device_descriptors.py +0 -787
  219. biolib/pyppeteer/pyppeteer/dialog.py +0 -79
  220. biolib/pyppeteer/pyppeteer/domworld.py +0 -597
  221. biolib/pyppeteer/pyppeteer/emulation_manager.py +0 -53
  222. biolib/pyppeteer/pyppeteer/errors.py +0 -48
  223. biolib/pyppeteer/pyppeteer/events.py +0 -63
  224. biolib/pyppeteer/pyppeteer/execution_context.py +0 -156
  225. biolib/pyppeteer/pyppeteer/frame/__init__.py +0 -299
  226. biolib/pyppeteer/pyppeteer/frame/frame_manager.py +0 -306
  227. biolib/pyppeteer/pyppeteer/helpers.py +0 -245
  228. biolib/pyppeteer/pyppeteer/input.py +0 -371
  229. biolib/pyppeteer/pyppeteer/jshandle.py +0 -598
  230. biolib/pyppeteer/pyppeteer/launcher.py +0 -683
  231. biolib/pyppeteer/pyppeteer/lifecycle_watcher.py +0 -169
  232. biolib/pyppeteer/pyppeteer/models/__init__.py +0 -103
  233. biolib/pyppeteer/pyppeteer/models/_protocol.py +0 -12460
  234. biolib/pyppeteer/pyppeteer/multimap.py +0 -82
  235. biolib/pyppeteer/pyppeteer/network_manager.py +0 -678
  236. biolib/pyppeteer/pyppeteer/options.py +0 -8
  237. biolib/pyppeteer/pyppeteer/page.py +0 -1728
  238. biolib/pyppeteer/pyppeteer/pipe_transport.py +0 -59
  239. biolib/pyppeteer/pyppeteer/target.py +0 -147
  240. biolib/pyppeteer/pyppeteer/task_queue.py +0 -24
  241. biolib/pyppeteer/pyppeteer/timeout_settings.py +0 -36
  242. biolib/pyppeteer/pyppeteer/tracing.py +0 -93
  243. biolib/pyppeteer/pyppeteer/us_keyboard_layout.py +0 -305
  244. biolib/pyppeteer/pyppeteer/util.py +0 -18
  245. biolib/pyppeteer/pyppeteer/websocket_transport.py +0 -47
  246. biolib/pyppeteer/pyppeteer/worker.py +0 -101
  247. biolib/pyppeteer/pyproject.toml +0 -97
  248. biolib/pyppeteer/spell.txt +0 -137
  249. biolib/pyppeteer/tox.ini +0 -72
  250. biolib/pyppeteer/utils/generate_protocol_types.py +0 -603
  251. biolib/start_cli.py +0 -7
  252. biolib/utils.py +0 -47
  253. biolib/validators/validate_app_version.py +0 -183
  254. biolib/validators/validate_argument.py +0 -134
  255. biolib/validators/validate_module.py +0 -323
  256. biolib/validators/validate_zip_file.py +0 -40
  257. biolib/validators/validator_utils.py +0 -103
  258. pybiolib-0.2.951.dist-info/LICENSE +0 -21
  259. pybiolib-0.2.951.dist-info/METADATA +0 -61
  260. pybiolib-0.2.951.dist-info/RECORD +0 -153
  261. pybiolib-0.2.951.dist-info/entry_points.txt +0 -3
  262. /LICENSE → /pybiolib-1.2.1890.dist-info/licenses/LICENSE +0 -0
@@ -1,299 +0,0 @@
1
- #!/usr/bin/env python
2
- # -*- coding: utf-8 -*-
3
- #
4
- # pyppeteer documentation build configuration file, created by
5
- # sphinx-quickstart on Tue Jul 9 22:26:36 2013.
6
- #
7
- # This file is execfile()d with the current directory set to its
8
- # containing dir.
9
- #
10
- # Note that not all possible configuration values are present in this
11
- # autogenerated file.
12
- #
13
- # All configuration values have a default; values that are commented out
14
- # serve to show the default.
15
-
16
- import os
17
- import sys
18
-
19
- import pyppeteer
20
-
21
- # If extensions (or modules to document with autodoc) are in another
22
- # directory, add these directories to sys.path here. If the directory is
23
- # relative to the documentation root, use os.path.abspath to make it
24
- # absolute, like shown here.
25
- # sys.path.insert(0, os.path.abspath('.'))
26
-
27
- # Get the project root dir, which is the parent dir of this
28
- cwd = os.getcwd()
29
- project_root = os.path.dirname(cwd)
30
-
31
- # Insert the project root dir as the first element in the PYTHONPATH.
32
- # This lets us ensure that the source package is imported, and that its
33
- # version is used.
34
- sys.path.insert(0, project_root)
35
-
36
-
37
- # -- General configuration ---------------------------------------------
38
-
39
- # If your documentation needs a minimal Sphinx version, state it here.
40
- # needs_sphinx = '1.0'
41
-
42
- # Add any Sphinx extension module names here, as strings. They can be
43
- # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
44
- extensions = [
45
- 'sphinx.ext.autodoc',
46
- 'sphinx.ext.githubpages',
47
- 'sphinx.ext.viewcode',
48
- # 'sphinx_autodoc_typehints',
49
- 'sphinxcontrib.asyncio',
50
- 'm2r',
51
- ]
52
-
53
- primary_domain = 'py'
54
- default_role = 'py:obj'
55
- # autodoc_member_order = 'bysource'
56
- # include class' and __init__'s docstring
57
- # autoclass_content = 'both'
58
- # autodoc_docstring_signature = False
59
- autodoc_default_flags = ['show-inheritance']
60
-
61
- suppress_warnings = ['image.nonlocal_uri']
62
-
63
- # Add any paths that contain templates here, relative to this directory.
64
- templates_path = ['_templates']
65
-
66
- # The suffix(es) of source filenames.
67
- # You can specify multiple suffix as a list of string:
68
- source_suffix = ['.rst', '.md']
69
-
70
- # The encoding of source files.
71
- # source_encoding = 'utf-8-sig'
72
-
73
- # The master toctree document.
74
- master_doc = 'index'
75
-
76
- # General information about the project.
77
- project = 'Pyppeteer'
78
- copyright = "2017, Hiroyuki Takagi"
79
-
80
- # The version info for the project you're documenting, acts as replacement
81
- # for |version| and |release|, also used in various other places throughout
82
- # the built documents.
83
- #
84
- # The short X.Y version.
85
- version = pyppeteer.__version__
86
- # The full version, including alpha/beta/rc tags.
87
- release = pyppeteer.__version__
88
-
89
- # The language for content autogenerated by Sphinx. Refer to documentation
90
- # for a list of supported languages.
91
- # language = None
92
-
93
- # There are two options for replacing |today|: either, you set today to
94
- # some non-false value, then it is used:
95
- # today = ''
96
- # Else, today_fmt is used as the format for a strftime call.
97
- # today_fmt = '%B %d, %Y'
98
-
99
- # List of patterns, relative to source directory, that match files and
100
- # directories to ignore when looking for source files.
101
- exclude_patterns = ['_build']
102
-
103
- # The reST default role (used for this markup: `text`) to use for all
104
- # documents.
105
- # default_role = None
106
-
107
- # If true, '()' will be appended to :func: etc. cross-reference text.
108
- # add_function_parentheses = True
109
-
110
- # If true, the current module name will be prepended to all description
111
- # unit titles (such as .. function::).
112
- # add_module_names = True
113
-
114
- # If true, sectionauthor and moduleauthor directives will be shown in the
115
- # output. They are ignored by default.
116
- # show_authors = False
117
-
118
- # The name of the Pygments (syntax highlighting) style to use.
119
- pygments_style = 'sphinx'
120
-
121
- # A list of ignored prefixes for module index sorting.
122
- # modindex_common_prefix = []
123
-
124
- # If true, keep warnings as "system message" paragraphs in the built
125
- # documents.
126
- # keep_warnings = False
127
-
128
-
129
- # -- Options for HTML output -------------------------------------------
130
-
131
- # The theme to use for HTML and HTML Help pages. See the documentation for
132
- # a list of builtin themes.
133
- html_theme = 'alabaster'
134
-
135
- # Theme options are theme-specific and customize the look and feel of a
136
- # theme further. For a list of options available for each theme, see the
137
- # documentation.
138
- html_theme_options = {
139
- 'description': ('Headless chrome/chromium automation library ' '(unofficial port of puppeteer)'),
140
- 'github_user': 'miyakogi',
141
- 'github_repo': 'pyppeteer',
142
- 'github_banner': True,
143
- 'github_type': 'mark',
144
- 'github_count': False,
145
- 'font_family': '"Charis SIL", "Noto Serif", serif',
146
- 'head_font_family': 'Lato, sans-serif',
147
- 'code_font_family': '"Code new roman", "Ubuntu Mono", monospace',
148
- 'code_font_size': '1rem',
149
- }
150
-
151
- # Add any paths that contain custom themes here, relative to this directory.
152
- # html_theme_path = []
153
-
154
- # The name for this set of Sphinx documents. If None, it defaults to
155
- # "<project> v<release> documentation".
156
- # html_title = None
157
-
158
- # A shorter title for the navigation bar. Default is the same as
159
- # html_title.
160
- # html_short_title = None
161
-
162
- # The name of an image file (relative to this directory) to place at the
163
- # top of the sidebar.
164
- # html_logo = None
165
-
166
- # The name of an image file (within the static path) to use as favicon
167
- # of the docs. This file should be a Windows icon file (.ico) being
168
- # 16x16 or 32x32 pixels large.
169
- # html_favicon = None
170
-
171
- # Add any paths that contain custom static files (such as style sheets)
172
- # here, relative to this directory. They are copied after the builtin
173
- # static files, so a file named "default.css" will overwrite the builtin
174
- # "default.css".
175
- html_static_path = ['_static']
176
-
177
- # If not '', a 'Last updated on:' timestamp is inserted at every page
178
- # bottom, using the given strftime format.
179
- # html_last_updated_fmt = '%b %d, %Y'
180
-
181
- # If true, SmartyPants will be used to convert quotes and dashes to
182
- # typographically correct entities.
183
- # html_use_smartypants = True
184
-
185
- # Custom sidebar templates, maps document names to template names.
186
- html_sidebars = {'**': ['about.html', 'navigation.html', 'relations.html', 'searchbox.html',]}
187
-
188
- # Additional templates that should be rendered to pages, maps page names
189
- # to template names.
190
- # html_additional_pages = {}
191
-
192
- # If false, no module index is generated.
193
- # html_domain_indices = True
194
-
195
- # If false, no index is generated.
196
- # html_use_index = True
197
-
198
- # If true, the index is split into individual pages for each letter.
199
- # html_split_index = False
200
-
201
- # If true, links to the reST sources are added to the pages.
202
- # html_show_sourcelink = True
203
-
204
- # If true, "Created using Sphinx" is shown in the HTML footer.
205
- # Default is True.
206
- # html_show_sphinx = True
207
-
208
- # If true, "(C) Copyright ..." is shown in the HTML footer.
209
- # Default is True.
210
- # html_show_copyright = True
211
-
212
- # If true, an OpenSearch description file will be output, and all pages
213
- # will contain a <link> tag referring to it. The value of this option
214
- # must be the base URL from which the finished HTML is served.
215
- # html_use_opensearch = ''
216
-
217
- # This is the file name suffix for HTML files (e.g. ".xhtml").
218
- # html_file_suffix = None
219
-
220
- # Output file base name for HTML help builder.
221
- htmlhelp_basename = 'pyppeteerdoc'
222
-
223
- # -- Options for LaTeX output ------------------------------------------
224
-
225
- latex_elements = {
226
- # The paper size ('letterpaper' or 'a4paper').
227
- # 'papersize': 'letterpaper',
228
- # The font size ('10pt', '11pt' or '12pt').
229
- # 'pointsize': '10pt',
230
- # Additional stuff for the LaTeX preamble.
231
- # 'preamble': '',
232
- }
233
-
234
- # Grouping the document tree into LaTeX files. List of tuples
235
- # (source start file, target name, title, author, documentclass
236
- # [howto/manual]).
237
- latex_documents = [
238
- ('index', 'pyppeteer.tex', 'pyppeteer Documentation', 'Hiroyuki Takagi', 'manual'),
239
- ]
240
-
241
- # The name of an image file (relative to this directory) to place at
242
- # the top of the title page.
243
- # latex_logo = None
244
-
245
- # For "manual" documents, if this is true, then toplevel headings
246
- # are parts, not chapters.
247
- # latex_use_parts = False
248
-
249
- # If true, show page references after internal links.
250
- # latex_show_pagerefs = False
251
-
252
- # If true, show URL addresses after external links.
253
- # latex_show_urls = False
254
-
255
- # Documents to append as an appendix to all manuals.
256
- # latex_appendices = []
257
-
258
- # If false, no module index is generated.
259
- # latex_domain_indices = True
260
-
261
-
262
- # -- Options for manual page output ------------------------------------
263
-
264
- # One entry per manual page. List of tuples
265
- # (source start file, name, description, authors, manual section).
266
- man_pages = [('index', 'pyppeteer', 'pyppeteer Documentation', ['Hiroyuki Takagi'], 1)]
267
-
268
- # If true, show URL addresses after external links.
269
- # man_show_urls = False
270
-
271
-
272
- # -- Options for Texinfo output ----------------------------------------
273
-
274
- # Grouping the document tree into Texinfo files. List of tuples
275
- # (source start file, target name, title, author,
276
- # dir menu entry, description, category)
277
- texinfo_documents = [
278
- (
279
- 'index',
280
- 'pyppeteer',
281
- 'pyppeteer Documentation',
282
- 'Hiroyuki Takagi',
283
- 'pyppeteer',
284
- 'One line description of project.',
285
- 'Miscellaneous',
286
- ),
287
- ]
288
-
289
- # Documents to append as an appendix to all manuals.
290
- # texinfo_appendices = []
291
-
292
- # If false, no module index is generated.
293
- # texinfo_domain_indices = True
294
-
295
- # How to display URL addresses: 'footnote', 'no', or 'inline'.
296
- # texinfo_show_urls = 'footnote'
297
-
298
- # If true, do not generate a @detailmenu in the "Top" node's menu.
299
- # texinfo_no_detailmenu = False
@@ -1,21 +0,0 @@
1
- Pyppeteer's documentation
2
- =========================
3
-
4
- .. mdinclude:: ../README.md
5
-
6
-
7
- Contents
8
- --------
9
-
10
- .. toctree::
11
- :maxdepth: 2
12
-
13
- reference
14
- changes
15
-
16
- Indices and tables
17
- ==================
18
-
19
- * :ref:`genindex`
20
- * :ref:`modindex`
21
- * :ref:`search`
@@ -1,242 +0,0 @@
1
- @ECHO OFF
2
-
3
- REM Command file for Sphinx documentation
4
-
5
- if "%SPHINXBUILD%" == "" (
6
- set SPHINXBUILD=sphinx-build
7
- )
8
- set BUILDDIR=_build
9
- set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
10
- set I18NSPHINXOPTS=%SPHINXOPTS% .
11
- if NOT "%PAPER%" == "" (
12
- set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
13
- set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
14
- )
15
-
16
- if "%1" == "" goto help
17
-
18
- if "%1" == "help" (
19
- :help
20
- echo.Please use `make ^<target^>` where ^<target^> is one of
21
- echo. html to make standalone HTML files
22
- echo. dirhtml to make HTML files named index.html in directories
23
- echo. singlehtml to make a single large HTML file
24
- echo. pickle to make pickle files
25
- echo. json to make JSON files
26
- echo. htmlhelp to make HTML files and a HTML help project
27
- echo. qthelp to make HTML files and a qthelp project
28
- echo. devhelp to make HTML files and a Devhelp project
29
- echo. epub to make an epub
30
- echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
31
- echo. text to make text files
32
- echo. man to make manual pages
33
- echo. texinfo to make Texinfo files
34
- echo. gettext to make PO message catalogs
35
- echo. changes to make an overview over all changed/added/deprecated items
36
- echo. xml to make Docutils-native XML files
37
- echo. pseudoxml to make pseudoxml-XML files for display purposes
38
- echo. linkcheck to check all external links for integrity
39
- echo. doctest to run all doctests embedded in the documentation if enabled
40
- goto end
41
- )
42
-
43
- if "%1" == "clean" (
44
- for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
45
- del /q /s %BUILDDIR%\*
46
- goto end
47
- )
48
-
49
-
50
- %SPHINXBUILD% 2> nul
51
- if errorlevel 9009 (
52
- echo.
53
- echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
54
- echo.installed, then set the SPHINXBUILD environment variable to point
55
- echo.to the full path of the 'sphinx-build' executable. Alternatively you
56
- echo.may add the Sphinx directory to PATH.
57
- echo.
58
- echo.If you don't have Sphinx installed, grab it from
59
- echo.http://sphinx-doc.org/
60
- exit /b 1
61
- )
62
-
63
- if "%1" == "html" (
64
- %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
65
- if errorlevel 1 exit /b 1
66
- echo.
67
- echo.Build finished. The HTML pages are in %BUILDDIR%/html.
68
- goto end
69
- )
70
-
71
- if "%1" == "dirhtml" (
72
- %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
73
- if errorlevel 1 exit /b 1
74
- echo.
75
- echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
76
- goto end
77
- )
78
-
79
- if "%1" == "singlehtml" (
80
- %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
81
- if errorlevel 1 exit /b 1
82
- echo.
83
- echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
84
- goto end
85
- )
86
-
87
- if "%1" == "pickle" (
88
- %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
89
- if errorlevel 1 exit /b 1
90
- echo.
91
- echo.Build finished; now you can process the pickle files.
92
- goto end
93
- )
94
-
95
- if "%1" == "json" (
96
- %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
97
- if errorlevel 1 exit /b 1
98
- echo.
99
- echo.Build finished; now you can process the JSON files.
100
- goto end
101
- )
102
-
103
- if "%1" == "htmlhelp" (
104
- %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
105
- if errorlevel 1 exit /b 1
106
- echo.
107
- echo.Build finished; now you can run HTML Help Workshop with the ^
108
- .hhp project file in %BUILDDIR%/htmlhelp.
109
- goto end
110
- )
111
-
112
- if "%1" == "qthelp" (
113
- %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
114
- if errorlevel 1 exit /b 1
115
- echo.
116
- echo.Build finished; now you can run "qcollectiongenerator" with the ^
117
- .qhcp project file in %BUILDDIR%/qthelp, like this:
118
- echo.^> qcollectiongenerator %BUILDDIR%\qthelp\pyppeteer.qhcp
119
- echo.To view the help file:
120
- echo.^> assistant -collectionFile %BUILDDIR%\qthelp\pyppeteer.ghc
121
- goto end
122
- )
123
-
124
- if "%1" == "devhelp" (
125
- %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
126
- if errorlevel 1 exit /b 1
127
- echo.
128
- echo.Build finished.
129
- goto end
130
- )
131
-
132
- if "%1" == "epub" (
133
- %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
134
- if errorlevel 1 exit /b 1
135
- echo.
136
- echo.Build finished. The epub file is in %BUILDDIR%/epub.
137
- goto end
138
- )
139
-
140
- if "%1" == "latex" (
141
- %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
142
- if errorlevel 1 exit /b 1
143
- echo.
144
- echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
145
- goto end
146
- )
147
-
148
- if "%1" == "latexpdf" (
149
- %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
150
- cd %BUILDDIR%/latex
151
- make all-pdf
152
- cd %BUILDDIR%/..
153
- echo.
154
- echo.Build finished; the PDF files are in %BUILDDIR%/latex.
155
- goto end
156
- )
157
-
158
- if "%1" == "latexpdfja" (
159
- %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
160
- cd %BUILDDIR%/latex
161
- make all-pdf-ja
162
- cd %BUILDDIR%/..
163
- echo.
164
- echo.Build finished; the PDF files are in %BUILDDIR%/latex.
165
- goto end
166
- )
167
-
168
- if "%1" == "text" (
169
- %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
170
- if errorlevel 1 exit /b 1
171
- echo.
172
- echo.Build finished. The text files are in %BUILDDIR%/text.
173
- goto end
174
- )
175
-
176
- if "%1" == "man" (
177
- %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
178
- if errorlevel 1 exit /b 1
179
- echo.
180
- echo.Build finished. The manual pages are in %BUILDDIR%/man.
181
- goto end
182
- )
183
-
184
- if "%1" == "texinfo" (
185
- %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
186
- if errorlevel 1 exit /b 1
187
- echo.
188
- echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
189
- goto end
190
- )
191
-
192
- if "%1" == "gettext" (
193
- %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
194
- if errorlevel 1 exit /b 1
195
- echo.
196
- echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
197
- goto end
198
- )
199
-
200
- if "%1" == "changes" (
201
- %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
202
- if errorlevel 1 exit /b 1
203
- echo.
204
- echo.The overview file is in %BUILDDIR%/changes.
205
- goto end
206
- )
207
-
208
- if "%1" == "linkcheck" (
209
- %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
210
- if errorlevel 1 exit /b 1
211
- echo.
212
- echo.Link check complete; look for any errors in the above output ^
213
- or in %BUILDDIR%/linkcheck/output.txt.
214
- goto end
215
- )
216
-
217
- if "%1" == "doctest" (
218
- %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
219
- if errorlevel 1 exit /b 1
220
- echo.
221
- echo.Testing of doctests in the sources finished, look at the ^
222
- results in %BUILDDIR%/doctest/output.txt.
223
- goto end
224
- )
225
-
226
- if "%1" == "xml" (
227
- %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
228
- if errorlevel 1 exit /b 1
229
- echo.
230
- echo.Build finished. The XML files are in %BUILDDIR%/xml.
231
- goto end
232
- )
233
-
234
- if "%1" == "pseudoxml" (
235
- %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
236
- if errorlevel 1 exit /b 1
237
- echo.
238
- echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
239
- goto end
240
- )
241
-
242
- :end