diff --git a/docs/README.md b/docs/README.md index 9fef0019e..2eee149e0 100644 --- a/docs/README.md +++ b/docs/README.md @@ -16,14 +16,14 @@ * Run `make html` * Either `open _build/html/index.html` (MacOS) or point your browser to `file:///path/to/your/clone/of/miller/docs/_build/html/index.html` * Submitting: - * `git add` your modified files, `git push`, and submit a PR at https://github.com/johnkerl/miller + * `git add` your modified files, `git commit`, `git push`, and submit a PR at https://github.com/johnkerl/miller * A nice markup reference: https://www.sphinx-doc.org/en/1.8/usage/restructuredtext/basics.html ## Notes * CSS: * I used the Sphinx Classic theme which I like a lot except the colors -- it's a blue scheme and Miller has never been blue. - * Files are in `docs/_static/*.css` where I marked mods with `/* CHANGE ME */`. + * Files are in `docs/_static/*.css` where I marked my mods with `/* CHANGE ME */`. * If you modify the CSS you must run `make clean html` (not just `make html`) then reload in your browser. * Live code: * I didn't find a way to include non-Python live-code examples within Sphinx so I adapted the pre-Sphinx Miller-doc strategy which is to have a generator script read a template file (here, `foo.rst.in`), run the marked lines, and generate the output file (`foo.rst`). diff --git a/docs/build.rst b/docs/build.rst new file mode 100644 index 000000000..92898fa01 --- /dev/null +++ b/docs/build.rst @@ -0,0 +1,7 @@ +.. + PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE. + +Installation +================================================================ + +To be ported diff --git a/docs/build.rst.in b/docs/build.rst.in new file mode 100644 index 000000000..f387f7d71 --- /dev/null +++ b/docs/build.rst.in @@ -0,0 +1,4 @@ +Installation +================================================================ + +To be ported diff --git a/docs/contact.rst b/docs/contact.rst new file mode 100644 index 000000000..58eb1e663 --- /dev/null +++ b/docs/contact.rst @@ -0,0 +1,7 @@ +.. + PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE. + +Contact +================================================================ + +To be ported diff --git a/docs/contact.rst.in b/docs/contact.rst.in new file mode 100644 index 000000000..6ea117132 --- /dev/null +++ b/docs/contact.rst.in @@ -0,0 +1,4 @@ +Contact +================================================================ + +To be ported diff --git a/docs/cookbook.rst b/docs/cookbook.rst index f89dc4759..c79c27507 100644 --- a/docs/cookbook.rst +++ b/docs/cookbook.rst @@ -1,7 +1,7 @@ .. PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE. -Cookbook -========= +Cookbook part 1: common patterns +================================================================ To be ported diff --git a/docs/cookbook.rst.in b/docs/cookbook.rst.in index 707fb1784..a0e52aae8 100644 --- a/docs/cookbook.rst.in +++ b/docs/cookbook.rst.in @@ -1,4 +1,4 @@ -Cookbook -========= +Cookbook part 1: common patterns +================================================================ To be ported diff --git a/docs/cookbook2.rst b/docs/cookbook2.rst new file mode 100644 index 000000000..e4d2ce58f --- /dev/null +++ b/docs/cookbook2.rst @@ -0,0 +1,7 @@ +.. + PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE. + +Cookbook part 2: Random things, and some math +================================================================ + +To be ported diff --git a/docs/cookbook2.rst.in b/docs/cookbook2.rst.in new file mode 100644 index 000000000..c537b0e90 --- /dev/null +++ b/docs/cookbook2.rst.in @@ -0,0 +1,4 @@ +Cookbook part 2: Random things, and some math +================================================================ + +To be ported diff --git a/docs/cookbook3.rst b/docs/cookbook3.rst new file mode 100644 index 000000000..ded5843f2 --- /dev/null +++ b/docs/cookbook3.rst @@ -0,0 +1,7 @@ +.. + PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE. + +Cookbook part 3: Stats with and without out-of-stream variables +================================================================ + +To be ported diff --git a/docs/cookbook3.rst.in b/docs/cookbook3.rst.in new file mode 100644 index 000000000..dfdb1f2fc --- /dev/null +++ b/docs/cookbook3.rst.in @@ -0,0 +1,4 @@ +Cookbook part 3: Stats with and without out-of-stream variables +================================================================ + +To be ported diff --git a/docs/customization.rst b/docs/customization.rst new file mode 100644 index 000000000..c764b9df6 --- /dev/null +++ b/docs/customization.rst @@ -0,0 +1,7 @@ +.. + PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE. + +Customization: .mlrrc +================================================================ + +To be ported diff --git a/docs/customization.rst.in b/docs/customization.rst.in new file mode 100644 index 000000000..c860befdc --- /dev/null +++ b/docs/customization.rst.in @@ -0,0 +1,4 @@ +Customization: .mlrrc +================================================================ + +To be ported diff --git a/docs/data-examples.rst b/docs/data-examples.rst new file mode 100644 index 000000000..3ed236335 --- /dev/null +++ b/docs/data-examples.rst @@ -0,0 +1,7 @@ +.. + PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE. + +Data-diving examples +================================================================ + +To be ported diff --git a/docs/data-examples.rst.in b/docs/data-examples.rst.in new file mode 100644 index 000000000..23e95b03b --- /dev/null +++ b/docs/data-examples.rst.in @@ -0,0 +1,4 @@ +Data-diving examples +================================================================ + +To be ported diff --git a/docs/data-sharing.rst b/docs/data-sharing.rst new file mode 100644 index 000000000..ecd71a872 --- /dev/null +++ b/docs/data-sharing.rst @@ -0,0 +1,7 @@ +.. + PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE. + +Mixing with other languages +================================================================ + +To be ported diff --git a/docs/data-sharing.rst.in b/docs/data-sharing.rst.in new file mode 100644 index 000000000..540012760 --- /dev/null +++ b/docs/data-sharing.rst.in @@ -0,0 +1,4 @@ +Mixing with other languages +================================================================ + +To be ported diff --git a/docs/etymology.rst b/docs/etymology.rst new file mode 100644 index 000000000..8fee3c835 --- /dev/null +++ b/docs/etymology.rst @@ -0,0 +1,7 @@ +.. + PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE. + +Why call it Miller? +================================================================ + +To be ported diff --git a/docs/etymology.rst.in b/docs/etymology.rst.in new file mode 100644 index 000000000..980523f2f --- /dev/null +++ b/docs/etymology.rst.in @@ -0,0 +1,4 @@ +Why call it Miller? +================================================================ + +To be ported diff --git a/docs/feature-comparison.rst b/docs/feature-comparison.rst new file mode 100644 index 000000000..31ed75bf0 --- /dev/null +++ b/docs/feature-comparison.rst @@ -0,0 +1,5 @@ +.. + PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE. + +Unix-toolkit context +================================================================ diff --git a/docs/feature-comparison.rst.in b/docs/feature-comparison.rst.in new file mode 100644 index 000000000..ddfab0f59 --- /dev/null +++ b/docs/feature-comparison.rst.in @@ -0,0 +1,2 @@ +Unix-toolkit context +================================================================ diff --git a/docs/index.rst b/docs/index.rst index b42ef0f15..a0343ed49 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,10 +8,13 @@ Overview :maxdepth: 2 :caption: Contents + doc-status about 10min file-formats - doc-status + feature-comparison + record-heterogeneity + internationalization Using Miller ^^^^^^^^^^^^ @@ -20,8 +23,13 @@ Using Miller :maxdepth: 2 :caption: Contents - cookbook faq + customization + data-sharing + cookbook + cookbook2 + cookbook3 + data-examples Reference ^^^^^^^^^ @@ -31,13 +39,35 @@ Reference :caption: Contents reference + reference-verbs + reference-dsl + manpage + release-docs + build Background ^^^^^^^^^^ +.. toctree:: + :maxdepth: 2 + :caption: Contents + + why + whyc + whyc-details + etymology + originality + performance + Repository ^^^^^^^^^^ +.. toctree:: + :maxdepth: 2 + :caption: Contents + + contact + Index ^^^^^ diff --git a/docs/internationalization.rst b/docs/internationalization.rst new file mode 100644 index 000000000..e9c2b745c --- /dev/null +++ b/docs/internationalization.rst @@ -0,0 +1,7 @@ +.. + PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE. + +Internationalization +================================================================ + +To be ported diff --git a/docs/internationalization.rst.in b/docs/internationalization.rst.in new file mode 100644 index 000000000..157f64687 --- /dev/null +++ b/docs/internationalization.rst.in @@ -0,0 +1,4 @@ +Internationalization +================================================================ + +To be ported diff --git a/docs/manpage.rst b/docs/manpage.rst new file mode 100644 index 000000000..d315dd12b --- /dev/null +++ b/docs/manpage.rst @@ -0,0 +1,7 @@ +.. + PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE. + +Manpage +================================================================ + +To be ported diff --git a/docs/manpage.rst.in b/docs/manpage.rst.in new file mode 100644 index 000000000..744cbe9c1 --- /dev/null +++ b/docs/manpage.rst.in @@ -0,0 +1,4 @@ +Manpage +================================================================ + +To be ported diff --git a/docs/originality.rst b/docs/originality.rst new file mode 100644 index 000000000..9ae816af0 --- /dev/null +++ b/docs/originality.rst @@ -0,0 +1,7 @@ +.. + PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE. + +How original is Miller? +================================================================ + +To be ported diff --git a/docs/originality.rst.in b/docs/originality.rst.in new file mode 100644 index 000000000..541642360 --- /dev/null +++ b/docs/originality.rst.in @@ -0,0 +1,4 @@ +How original is Miller? +================================================================ + +To be ported diff --git a/docs/performance.rst b/docs/performance.rst new file mode 100644 index 000000000..fa72c75cb --- /dev/null +++ b/docs/performance.rst @@ -0,0 +1,7 @@ +.. + PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE. + +Performance +================================================================ + +To be ported diff --git a/docs/performance.rst.in b/docs/performance.rst.in new file mode 100644 index 000000000..d3b71740d --- /dev/null +++ b/docs/performance.rst.in @@ -0,0 +1,4 @@ +Performance +================================================================ + +To be ported diff --git a/docs/record-heterogeneity.rst b/docs/record-heterogeneity.rst new file mode 100644 index 000000000..796ee914f --- /dev/null +++ b/docs/record-heterogeneity.rst @@ -0,0 +1,7 @@ +.. + PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE. + +Record-heterogeneity +================================================================ + +To be ported diff --git a/docs/record-heterogeneity.rst.in b/docs/record-heterogeneity.rst.in new file mode 100644 index 000000000..e9e4a6709 --- /dev/null +++ b/docs/record-heterogeneity.rst.in @@ -0,0 +1,4 @@ +Record-heterogeneity +================================================================ + +To be ported diff --git a/docs/reference-dsl.rst b/docs/reference-dsl.rst new file mode 100644 index 000000000..04dcfcfa9 --- /dev/null +++ b/docs/reference-dsl.rst @@ -0,0 +1,7 @@ +.. + PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE. + +DSL reference +================================================================ + +To be ported diff --git a/docs/reference-dsl.rst.in b/docs/reference-dsl.rst.in new file mode 100644 index 000000000..96f705ccc --- /dev/null +++ b/docs/reference-dsl.rst.in @@ -0,0 +1,4 @@ +DSL reference +================================================================ + +To be ported diff --git a/docs/reference-verbs.rst b/docs/reference-verbs.rst new file mode 100644 index 000000000..44d4c8d9d --- /dev/null +++ b/docs/reference-verbs.rst @@ -0,0 +1,7 @@ +.. + PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE. + +Verbs reference +================================================================ + +To be ported diff --git a/docs/reference-verbs.rst.in b/docs/reference-verbs.rst.in new file mode 100644 index 000000000..43def7731 --- /dev/null +++ b/docs/reference-verbs.rst.in @@ -0,0 +1,4 @@ +Verbs reference +================================================================ + +To be ported diff --git a/docs/reference.rst b/docs/reference.rst index 9c46a8c2e..7c5f3ff63 100644 --- a/docs/reference.rst +++ b/docs/reference.rst @@ -1,7 +1,7 @@ .. PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE. -Reference -========= +Main reference +================================================================ To be ported diff --git a/docs/reference.rst.in b/docs/reference.rst.in index 8aa0cf7c3..df72efb27 100644 --- a/docs/reference.rst.in +++ b/docs/reference.rst.in @@ -1,4 +1,4 @@ -Reference -========= +Main reference +================================================================ To be ported diff --git a/docs/release-docs.rst b/docs/release-docs.rst new file mode 100644 index 000000000..71fe9d541 --- /dev/null +++ b/docs/release-docs.rst @@ -0,0 +1,7 @@ +.. + PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE. + +Documents by release +================================================================ + +To be ported diff --git a/docs/release-docs.rst.in b/docs/release-docs.rst.in new file mode 100644 index 000000000..85e8cf542 --- /dev/null +++ b/docs/release-docs.rst.in @@ -0,0 +1,4 @@ +Documents by release +================================================================ + +To be ported diff --git a/docs/why.rst b/docs/why.rst new file mode 100644 index 000000000..ed49d6d4a --- /dev/null +++ b/docs/why.rst @@ -0,0 +1,7 @@ +.. + PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE. + +Why? +================================================================ + +To be ported diff --git a/docs/why.rst.in b/docs/why.rst.in new file mode 100644 index 000000000..c3ca6ce90 --- /dev/null +++ b/docs/why.rst.in @@ -0,0 +1,4 @@ +Why? +================================================================ + +To be ported diff --git a/docs/whyc-details.rst b/docs/whyc-details.rst new file mode 100644 index 000000000..c47c26043 --- /dev/null +++ b/docs/whyc-details.rst @@ -0,0 +1,7 @@ +.. + PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE. + +Why C: details +================================================================ + +To be ported diff --git a/docs/whyc-details.rst.in b/docs/whyc-details.rst.in new file mode 100644 index 000000000..0ff936ca1 --- /dev/null +++ b/docs/whyc-details.rst.in @@ -0,0 +1,4 @@ +Why C: details +================================================================ + +To be ported diff --git a/docs/whyc.rst b/docs/whyc.rst new file mode 100644 index 000000000..b85e9f78e --- /dev/null +++ b/docs/whyc.rst @@ -0,0 +1,7 @@ +.. + PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE. + +Why C? +================================================================ + +To be ported diff --git a/docs/whyc.rst.in b/docs/whyc.rst.in new file mode 100644 index 000000000..f09db726e --- /dev/null +++ b/docs/whyc.rst.in @@ -0,0 +1,4 @@ +Why C? +================================================================ + +To be ported