https://github.com/fmatter/langdoc-script-collection
A collection of scripts for common language documentation workflows
https://github.com/fmatter/langdoc-script-collection
Last synced: 2 months ago
JSON representation
A collection of scripts for common language documentation workflows
- Host: GitHub
- URL: https://github.com/fmatter/langdoc-script-collection
- Owner: fmatter
- Created: 2023-11-09T22:54:45.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-11T17:06:19.000Z (over 1 year ago)
- Last Synced: 2024-04-18T14:31:09.796Z (about 1 year ago)
- Language: Python
- Homepage: https://fl.mt/langdoc-script-collection/
- Size: 925 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Language documentation script collection
This is a collection of scripts for common language documentation workflows.
Download a [ZIP](https://github.com/fmatter/langdoc-script-collection/archive/refs/heads/main.zip) from or clone the repository:```
git clone https://github.com/fmatter/langdoc-script-collection
```See the documentation for individual scripts for usage instructions.
It is recommended to use a [virtual environment](https://docs.python.org/3/library/venv.html) to install necessary packages.## Contribute a new script
To add a script to the collection, [fork the github repository](https://github.com/fmatter/langdoc-script-collection/fork), use a [virtual environment](https://docs.python.org/3/library/venv.html) to `pip install -r requirements.txt`, and add the following files to your fork:1. a `my_script.py` (or other suffix) file, ideally with:
* name and contact info
* comments where necessary
* a license
2. a `docs/scripts/my_script.md` file with least:
* basic setup and usage instructions
* tags for software / format (check mkdocs.yaml and add if necessary)
* requirementsLook at existing scripts and their documentation to compare.
Run `mkdocs serve` and visit [`localhost:8000`](http://localhost:8000).
Finally, create a pull request.## Other software
* [cldflex](https://github.com/fmatter/cldflex/)
* [flexpy](https://github.com/Kuhron/flexpy)
* ...