autogenerated mdbook documentation

Cargo.toml

@@ -9,6 +9,7 @@ version = "0.0.9"
 authors = ["uutils developers"]
 license = "MIT"
 description = "coreutils ~ GNU coreutils (updated); implemented as universal (cross-platform) utils, written in Rust"
+default-run = "coreutils"
 
 homepage = "https://github.com/uutils/coreutils"
 repository = "https://github.com/uutils/coreutils"

docs/.gitignore

@@ -0,0 +1,2 @@
+book
+_generated

docs/CONTRIBUTING.md

@@ -0,0 +1 @@
+# Contributing

docs/arch.rst

@@ -1,28 +0,0 @@
-.. print machine hardware name
-
-====
-arch
-====
-
-.. FIXME: this needs to be autogenerated somehow
-
---------
-Synopsis
---------
-
-``arch`` [OPTION]...
-
------------
-Description
------------
-
-``arch`` is an alias for ``uname -m``.  They both print the machine hardware
-name.
-
-An exit code of zero indicates success, whereas anything else means failure.
-For this program, a non-zero exit code generally means the user provided
-invalid options.
-
--h, --help       print a help menu for this program displaying accepted
-                 options and arguments
--v, --version    print the version number of this program

docs/book.toml

@@ -0,0 +1,9 @@
+[book]
+authors = ["uutils contributors"]
+language = "en"
+multilingual = false
+src = "src"
+title = "Uutils Documentation"
+
+[output.html]
+git-repository-url = "https://github.com/rust-lang/cargo/tree/master/src/doc/src"

docs/create_docs.py

@@ -0,0 +1,20 @@
+# Simple script to create the correct SUMMARY.md and other files
+# for the mdbook documentation.
+# Note: This will overwrite the existing files!
+
+import os
+
+with open('src/utils/index.md', 'w') as index:
+    with open('src/SUMMARY.md', 'w') as summary:
+        summary.write("# Summary\n\n")
+        summary.write("* [Introduction](introduction.md)\n")
+        summary.write("* [Contributing](contributing.md)\n")
+        summary.write("* [Utils](utils/index.md)\n")
+        index.write("# Utils\n\n")
+        for d in sorted(os.listdir('../src/uu')):
+            with open(f"src/utils/{d}.md", 'w') as f:
+                f.write(f"# {d}\n\n")
+                f.write(f"{{{{ #include ../../_generated/{d}-help.md }}}}\n")
+                print(f"Created docs/src/utils/{d}.md")
+            summary.write(f"  * [{d}](utils/{d}.md)\n")
+            index.write(f"* [{d}](./{d}.md)\n")

docs/docs/.gitignore

@@ -1 +0,0 @@
-book

docs/docs/book.toml

@@ -1,6 +0,0 @@
-[book]
-authors = ["Terts Diepraam"]
-language = "en"
-multilingual = false
-src = "src"
-title = "Uutils Documentation"

docs/docs/src/SUMMARY.md

@@ -1,3 +0,0 @@
-# Summary
-
-- [Chapter 1](./chapter_1.md)

docs/docs/src/chapter_1.md

@@ -1 +0,0 @@
-# Chapter 1

docs/index.rst

@@ -1,24 +0,0 @@
-.. uutils documentation master file, created by
-   sphinx-quickstart on Tue Dec  5 23:20:18 2017.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-..
-   spell-checker:ignore (directives) genindex maxdepth modindex toctree ; (misc) quickstart
-
-Welcome to uutils' documentation!
-=================================
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
-
-   arch
-   uutils
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`

docs/src/SUMMARY.md

@@ -0,0 +1,105 @@
+# Summary
+
+* [Introduction](introduction.md)
+* [Contributing](contributing.md)
+* [Utils](utils/index.md)
+  * [arch](utils/arch.md)
+  * [base32](utils/base32.md)
+  * [base64](utils/base64.md)
+  * [basename](utils/basename.md)
+  * [basenc](utils/basenc.md)
+  * [cat](utils/cat.md)
+  * [chcon](utils/chcon.md)
+  * [chgrp](utils/chgrp.md)
+  * [chmod](utils/chmod.md)
+  * [chown](utils/chown.md)
+  * [chroot](utils/chroot.md)
+  * [cksum](utils/cksum.md)
+  * [comm](utils/comm.md)
+  * [cp](utils/cp.md)
+  * [csplit](utils/csplit.md)
+  * [cut](utils/cut.md)
+  * [date](utils/date.md)
+  * [dd](utils/dd.md)
+  * [df](utils/df.md)
+  * [dircolors](utils/dircolors.md)
+  * [dirname](utils/dirname.md)
+  * [du](utils/du.md)
+  * [echo](utils/echo.md)
+  * [env](utils/env.md)
+  * [expand](utils/expand.md)
+  * [expr](utils/expr.md)
+  * [factor](utils/factor.md)
+  * [false](utils/false.md)
+  * [fmt](utils/fmt.md)
+  * [fold](utils/fold.md)
+  * [groups](utils/groups.md)
+  * [hashsum](utils/hashsum.md)
+  * [head](utils/head.md)
+  * [hostid](utils/hostid.md)
+  * [hostname](utils/hostname.md)
+  * [id](utils/id.md)
+  * [install](utils/install.md)
+  * [join](utils/join.md)
+  * [kill](utils/kill.md)
+  * [link](utils/link.md)
+  * [ln](utils/ln.md)
+  * [logname](utils/logname.md)
+  * [ls](utils/ls.md)
+  * [mkdir](utils/mkdir.md)
+  * [mkfifo](utils/mkfifo.md)
+  * [mknod](utils/mknod.md)
+  * [mktemp](utils/mktemp.md)
+  * [more](utils/more.md)
+  * [mv](utils/mv.md)
+  * [nice](utils/nice.md)
+  * [nl](utils/nl.md)
+  * [nohup](utils/nohup.md)
+  * [nproc](utils/nproc.md)
+  * [numfmt](utils/numfmt.md)
+  * [od](utils/od.md)
+  * [paste](utils/paste.md)
+  * [pathchk](utils/pathchk.md)
+  * [pinky](utils/pinky.md)
+  * [pr](utils/pr.md)
+  * [printenv](utils/printenv.md)
+  * [printf](utils/printf.md)
+  * [ptx](utils/ptx.md)
+  * [pwd](utils/pwd.md)
+  * [readlink](utils/readlink.md)
+  * [realpath](utils/realpath.md)
+  * [relpath](utils/relpath.md)
+  * [rm](utils/rm.md)
+  * [rmdir](utils/rmdir.md)
+  * [runcon](utils/runcon.md)
+  * [seq](utils/seq.md)
+  * [shred](utils/shred.md)
+  * [shuf](utils/shuf.md)
+  * [sleep](utils/sleep.md)
+  * [sort](utils/sort.md)
+  * [split](utils/split.md)
+  * [stat](utils/stat.md)
+  * [stdbuf](utils/stdbuf.md)
+  * [sum](utils/sum.md)
+  * [sync](utils/sync.md)
+  * [tac](utils/tac.md)
+  * [tail](utils/tail.md)
+  * [tee](utils/tee.md)
+  * [test](utils/test.md)
+  * [timeout](utils/timeout.md)
+  * [touch](utils/touch.md)
+  * [tr](utils/tr.md)
+  * [true](utils/true.md)
+  * [truncate](utils/truncate.md)
+  * [tsort](utils/tsort.md)
+  * [tty](utils/tty.md)
+  * [uname](utils/uname.md)
+  * [unexpand](utils/unexpand.md)
+  * [uniq](utils/uniq.md)
+  * [unlink](utils/unlink.md)
+  * [uptime](utils/uptime.md)
+  * [users](utils/users.md)
+  * [wc](utils/wc.md)
+  * [who](utils/who.md)
+  * [whoami](utils/whoami.md)
+  * [yes](utils/yes.md)

docs/src/contributing.md

@@ -0,0 +1 @@
+{{ #include ../../CONTRIBUTING.md }}

docs/src/introduction.md

@@ -0,0 +1,8 @@
+# Introduction
+
+uutils is an attempt at writing universal (as in cross-platform) CLI
+utilities in [Rust](https://www.rust-lang.org). The source code is hosted
+on [GitHub](https://github.com/uutils/coreutils).
+
+> Note: This manual is automatically generated from the source code and is
+> a work in progress.

docs/src/utils/arch.md

@@ -0,0 +1,3 @@
+# arch
+
+{{ #include ../../_generated/arch-help.md }}

docs/src/utils/base32.md

@@ -0,0 +1,3 @@
+# base32
+
+{{ #include ../../_generated/base32-help.md }}

docs/src/utils/base64.md

@@ -0,0 +1,3 @@
+# base64
+
+{{ #include ../../_generated/base64-help.md }}

docs/src/utils/basename.md

@@ -0,0 +1,3 @@
+# basename
+
+{{ #include ../../_generated/basename-help.md }}

docs/src/utils/basenc.md

@@ -0,0 +1,3 @@
+# basenc
+
+{{ #include ../../_generated/basenc-help.md }}