Add sphinx documentation (similar to https://mzspeclib.readthedocs.io). The documentation contains the GitHub readme, the specification, and documentation for the LARK grammar, JSON Schema, regular expressions, and Python package.
Currently, the specification page links to the latest draft Word document, but when formally accepted, we could put it on the web page integrally.
For some sections in the documentation, the Sphinx conf.py script automatically generates some markdown files from JSON files, and copies the railroad diagram. No GitHub actions are required for this, as this code runs on docs-generation at readthedocs.io.
To do's
[ ] README.md: Provide short intro on regexes and lark
Add sphinx documentation (similar to https://mzspeclib.readthedocs.io). The documentation contains the GitHub readme, the specification, and documentation for the LARK grammar, JSON Schema, regular expressions, and Python package.
Currently, the specification page links to the latest draft Word document, but when formally accepted, we could put it on the web page integrally.
For some sections in the documentation, the Sphinx
conf.pyscript automatically generates some markdown files from JSON files, and copies the railroad diagram. No GitHub actions are required for this, as this code runs on docs-generation at readthedocs.io.To do's
README.md: Provide short intro on regexes and larklark/index.rst: Add short about section