Language documentation script collection
This is a collection of scripts for common language documentation workflows. Download a ZIP from or clone the repository:
See the documentation for individual scripts for usage instructions. It is recommended to use a virtual environment to install necessary packages.
Contribute a new script
To add a script to the collection, fork the github repository, use a virtual environment to pip install -r requirements.txt
, and add the following files to your fork:
- a
my_script.py
(or other suffix) file, ideally with:- name and contact info
- comments where necessary
- a license
- a
docs/scripts/my_script.md
file with least:- basic setup and usage instructions
- tags (check mkdocs.yaml and add if neessary)
- requirements
Look at existing scripts and their documentation to compare
Run mkdocs serve
and visit localhost:8000
.
Finally, create a pull request.
Other software
Last update:
November 9, 2023