gcode-documentation-parser
See a demo usage of the output
A utility that parses the documentation pages from Marlin, RepRap, and Klipper, to generate an index of commands usage.
Output
You can access the output from the output branch of this repo. Here are the raw links that you can reference or copy:
- all_codes.json: A JSON file containing the documentation
- all_codes_window.js: A JS file that defines
AllGcodeson the global windowobject- all_codes_const.js: A JS file that defines a
const AllGcodes - all_codes_export.js: A JS file that exports an
AllGcodesvalue
The documentation is updated semi-regularly, at the start of every month, and published on this repo.
You can also generate it locally by running the following, and checking the
output folder
poetry run ./update_documentation.py
Usage
Normally, the output would be used by something like gcode-documentation, to allow users to search and understand how a GCode command should be used.
This was originally created in Octoprint plugin MarlinGcodeDocumentation, and needs the parsed documentation data to function.
1 maintainer
Metadata
1 maintainer
Release files for gcode-documentation-parser 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| gcode-documentation-parser-0.1.0.tar.gz | 10.4 kB | Without provenance | Details for gcode-documentation-parser-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| gcode_documentation_parser-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for gcode_documentation_parser-0.1.0-py3-none-any.whl |
Total release size: 22.7 kB
Release files / gcode-documentation-parser-0.1.0.tar.gz
| Download URL | gcode-documentation-parser-0.1.0.tar.gz |
|---|---|
| Size | 10.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
550de1525000a6260d3e441aa3396d5c3321e66d509f71bfdd9e7438b65e335e
|
|
BLAKE2b-256 checksum How to use checksums |
c877612d4ac0430b6100da9531788e005a66d0c0c9f3366cc7493b80e033bfe2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.12 CPython/3.8.10 Linux/5.13.0-22-generic
|
Release files / gcode_documentation_parser-0.1.0-py3-none-any.whl
| Download URL | gcode_documentation_parser-0.1.0-py3-none-any.whl |
|---|---|
| Size | 12.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e2e5d9b89d6a0912188dbfcdca2c82320f87934de864b815fdb49e3085aeeb44
|
|
BLAKE2b-256 checksum How to use checksums |
b8b0e985fe1f25d9e03c47243d02967f054c088be8834d1d68562d36fc574d9b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.12 CPython/3.8.10 Linux/5.13.0-22-generic
|
Security for gcode-documentation-parser 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
