How to contribute

Community

You can ask questions -- or answer them! -- following the links at Community.

After sudo pip install sphinx (or pip3) you should be able to do make html.

Edit *.md.in files, then make html to generate *.md, then run the Sphinx document-generator.

Open _build/html/index.html in your browser, e.g. file:////Users/yourname/git/miller/docs6/_build/html/contributing.html, to verify.

Once PRs are merged, readthedocs creates https://miller.readthedocs.io using the following configs:

As of Miller-6's current pre-release status, the best way to test is to either build from source via Building from source, or by getting a recent binary at https://github.com/johnkerl/miller/actions, then click latest build, then Artifacts. Then simply use Miller for whatever you do, and create an issue at https://github.com/johnkerl/miller/issues.

Do note that as of 2021-06-17 a few things have not been ported to Miller 6 -- most notably, including regex captures and localtime DSL functions.