skeleton

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`).

docs/build.rst

@@ -0,0 +1,7 @@
+..
+    PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE.
+
+Installation
+================================================================
+
+To be ported

docs/build.rst.in

@@ -0,0 +1,4 @@
+Installation
+================================================================
+
+To be ported

docs/contact.rst

@@ -0,0 +1,7 @@
+..
+    PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE.
+
+Contact
+================================================================
+
+To be ported

docs/contact.rst.in

@@ -0,0 +1,4 @@
+Contact
+================================================================
+
+To be ported

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

docs/cookbook.rst.in

@@ -1,4 +1,4 @@
-Cookbook
-=========
+Cookbook part 1: common patterns
+================================================================
 
 To be ported

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

docs/cookbook2.rst.in

@@ -0,0 +1,4 @@
+Cookbook part 2: Random things, and some math
+================================================================
+
+To be ported

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

docs/cookbook3.rst.in

@@ -0,0 +1,4 @@
+Cookbook part 3: Stats with and without out-of-stream variables
+================================================================
+
+To be ported

docs/customization.rst

@@ -0,0 +1,7 @@
+..
+    PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE.
+
+Customization: .mlrrc
+================================================================
+
+To be ported

docs/customization.rst.in

@@ -0,0 +1,4 @@
+Customization: .mlrrc
+================================================================
+
+To be ported

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

docs/data-examples.rst.in

@@ -0,0 +1,4 @@
+Data-diving examples
+================================================================
+
+To be ported

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

docs/data-sharing.rst.in

@@ -0,0 +1,4 @@
+Mixing with other languages
+================================================================
+
+To be ported

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

docs/etymology.rst.in

@@ -0,0 +1,4 @@
+Why call it Miller?
+================================================================
+
+To be ported

docs/feature-comparison.rst

@@ -0,0 +1,5 @@
+..
+    PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE.
+
+Unix-toolkit context
+================================================================

docs/feature-comparison.rst.in

@@ -0,0 +1,2 @@
+Unix-toolkit context
+================================================================

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
 ^^^^^
 

docs/internationalization.rst

@@ -0,0 +1,7 @@
+..
+    PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE.
+
+Internationalization
+================================================================
+
+To be ported

docs/internationalization.rst.in

@@ -0,0 +1,4 @@
+Internationalization
+================================================================
+
+To be ported

docs/manpage.rst

@@ -0,0 +1,7 @@
+..
+    PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE.
+
+Manpage
+================================================================
+
+To be ported

docs/manpage.rst.in

@@ -0,0 +1,4 @@
+Manpage
+================================================================
+
+To be ported

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

docs/originality.rst.in

@@ -0,0 +1,4 @@
+How original is Miller?
+================================================================
+
+To be ported

docs/performance.rst

@@ -0,0 +1,7 @@
+..
+    PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE.
+
+Performance
+================================================================
+
+To be ported

docs/performance.rst.in

@@ -0,0 +1,4 @@
+Performance
+================================================================
+
+To be ported

docs/record-heterogeneity.rst

@@ -0,0 +1,7 @@
+..
+    PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE.
+
+Record-heterogeneity
+================================================================
+
+To be ported

docs/record-heterogeneity.rst.in

@@ -0,0 +1,4 @@
+Record-heterogeneity
+================================================================
+
+To be ported

docs/reference-dsl.rst

@@ -0,0 +1,7 @@
+..
+    PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE.
+
+DSL reference
+================================================================
+
+To be ported

docs/reference-dsl.rst.in

@@ -0,0 +1,4 @@
+DSL reference
+================================================================
+
+To be ported

docs/reference-verbs.rst

@@ -0,0 +1,7 @@
+..
+    PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE.
+
+Verbs reference
+================================================================
+
+To be ported

docs/reference-verbs.rst.in

@@ -0,0 +1,4 @@
+Verbs reference
+================================================================
+
+To be ported

docs/reference.rst

@@ -1,7 +1,7 @@
 ..
     PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE.
 
-Reference
-=========
+Main reference
+================================================================
 
 To be ported

docs/reference.rst.in

@@ -1,4 +1,4 @@
-Reference
-=========
+Main reference
+================================================================
 
 To be ported

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

docs/release-docs.rst.in

@@ -0,0 +1,4 @@
+Documents by release
+================================================================
+
+To be ported

docs/why.rst

@@ -0,0 +1,7 @@
+..
+    PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE.
+
+Why?
+================================================================
+
+To be ported

docs/why.rst.in

@@ -0,0 +1,4 @@
+Why?
+================================================================
+
+To be ported

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

docs/whyc-details.rst.in

@@ -0,0 +1,4 @@
+Why C: details
+================================================================
+
+To be ported

docs/whyc.rst

@@ -0,0 +1,7 @@
+..
+    PLEASE DO NOT EDIT DIRECTLY. EDIT THE .rst.in FILE PLEASE.
+
+Why C?
+================================================================
+
+To be ported

docs/whyc.rst.in

@@ -0,0 +1,4 @@
+Why C?
+================================================================
+
+To be ported