Simon Michael
c773a81447
shake: update txt man pages when man pages change
2016-04-13 22:47:19 -07:00
Simon Michael
2931bd6085
doc: update some docs mentioning --help
2016-04-13 22:47:02 -07:00
Simon Michael
b73bcda52a
include txt man pages in cabal tarballs
2016-04-13 22:38:53 -07:00
Simon Michael
48f89314d5
hledger: long --help flag shows man page
...
hledger now embeds its man page, and will display it on --help (like
Ledger and git). -h and --help are now different, like git.
2016-04-13 22:32:04 -07:00
Simon Michael
bfa5e14373
doc: generate (and commit) text-rendred man pages
...
Intended for embedding in executables. Quick implementation,
hopefully these are fixed-width and compatible with all terminals.
2016-04-13 22:29:16 -07:00
Simon Michael
7a53895cdf
site: docs: fix combined manual link, cleanup
2016-04-13 21:02:14 -07:00
Simon Michael
47823d2ed7
doc: git ignore new manual
2016-04-12 21:22:58 -07:00
Simon Michael
588f36d662
rename timelog format to timeclock
2016-04-12 21:13:19 -07:00
Simon Michael
3e53cf7ef9
tools: fix outdated yaml paths in tags
2016-04-12 21:12:39 -07:00
Simon Michael
6c180039b1
site: add filename in home link for local viewing
2016-04-12 20:32:33 -07:00
Simon Michael
40b521255b
site: download: demote release notes link
2016-04-12 20:32:14 -07:00
Simon Michael
bf4e6c314c
shake: use default build dir
2016-04-12 20:32:01 -07:00
Simon Michael
8ee0c7fa76
doc: update man pages
2016-04-12 20:31:17 -07:00
Simon Michael
5ef67e0d4d
doc: remove old manual. No more duplication! #292
2016-04-12 20:29:29 -07:00
Simon Michael
aecbcf9461
doc: merge last bits of old manual into new one
2016-04-12 20:22:40 -07:00
Simon Michael
b4d491791c
doc: include nroff man pages in cabal tarballs
2016-04-12 11:25:46 -07:00
Simon Michael
5e71d749c4
doc: ensure all five main packages have a README
2016-04-12 11:13:01 -07:00
Simon Michael
d6601aff24
site: more docs page fiddling. Getting there
2016-04-10 18:20:55 -07:00
Simon Michael
96a6d2239a
doc: CSV: headings, clarifications
2016-04-10 18:19:43 -07:00
Simon Michael
b69b149d39
doc: hledger: add more content from old manual
2016-04-10 12:13:38 -07:00
Simon Michael
db96d54ec0
doc: separate docs target that skips the site
2016-04-10 12:11:19 -07:00
Simon Michael
69be70e604
site: some preliminary style tweaks for examples
2016-04-10 12:10:34 -07:00
Simon Michael
3c7e1a7399
doc: some convenient m4 macros for docs
2016-04-10 12:09:39 -07:00
Simon Michael
febfa3fd0f
doc: commit missing hledger-api nroff
2016-04-10 12:07:22 -07:00
Simon Michael
6a019eedc6
shake: also build/clean hakyll-std and website
2016-04-09 14:24:33 -07:00
Simon Michael
5754f2bb4a
doc: updates, merge some more from old manual
2016-04-09 14:23:55 -07:00
Simon Michael
4b9d30dac3
doc: man page template tweaks
2016-04-09 14:02:37 -07:00
Simon Michael
fa9105f658
doc: heading/combined manual tweaks
2016-04-09 14:02:37 -07:00
Simon Michael
e4aaa302ce
doc: use m4 just to assemble main hledger man page
...
I was about to drop the m4 experiment, but.. not yet. I want to split up
the big man pages into chunks that are easier to deal with, so now using
m4 for that (only. Pandoc is taking care of selective content stripping
and other rendering adjustments.)
I've switched the suffix of m4-enabled files from .md.m4 to .m4.md -
less correct but activates more useful editor highlighting.
2016-04-09 13:30:21 -07:00
Simon Michael
88eb113f7b
doc: generate atx-style headers in markdown
2016-04-09 12:06:45 -07:00
Simon Michael
ed1122fec1
site: new simpler docs page
...
This docs page is less verbose, and should make it easier to know what
you should read next, and what you don't need to read.
The reference docs are still in flux, with three alternatives presented:
1. the old manual, 2. the new individual man pages, and 3. the new
manual which combines the man pages. At this point I think that 2 will
get top billing, 3 will also be provided, and 1 will be dropped when 2/3
are a bit better.
2016-04-08 07:03:37 -07:00
Simon Michael
775ab2fd4e
site: simplify man page uris; shake cleanups
2016-04-08 07:01:40 -07:00
Simon Michael
5d9d155ca0
doc: misc cleanups
2016-04-07 21:59:30 -07:00
Simon Michael
33e2ca927f
doc: improve new combined manual, cleanups
2016-04-07 21:58:42 -07:00
Simon Michael
0982aca223
tools: missing file, git ignore
2016-04-07 09:05:16 -07:00
Simon Michael
dea0c5973a
site: devguide: github haskell star ranking tweak
2016-04-07 08:57:48 -07:00
Simon Michael
69542160bb
doc: remove colons from man page headings
2016-04-07 08:55:53 -07:00
Simon Michael
443b870481
site: fix man page TOCs, add combined man page
2016-04-07 08:55:21 -07:00
Simon Michael
bba7909165
doc: m4-based man pages pt 2, missing files
2016-04-06 09:03:01 -07:00
Simon Michael
1aa1a92f96
doc: m4manpages should also depend on m4 includes
2016-04-06 08:51:14 -07:00
Simon Michael
f3a2690f7c
doc: experimental m4-based man page build process
...
The new m4manpages, m4webmanpages targets generate nroff and markdown
man pages via an alternate, excitingly complicated process, involving
shake, hakyll, pandoc *and* m4. Currently just the hledger man page is
processed this way, and the output (hledger/doc/m4-hledger.1,
site/m4-hledger.1.md) is equivalent to that of the non-m4 process.
Pro: selecting and massaging web/man content may be smoother with m4
than with pandoc filters. File inclusion allows documentation to be
broken up into chunks, which may be easier to edit, reorganize and
reuse. Macros could reduce boilerplate and enable more featureful and
attractive docs.
Con: the non-m4 process was simpler, easier to for contributors to
understand and working well enough. YAGNI.
2016-04-06 08:44:59 -07:00
Simon Michael
f3fb1a89f2
doc: exclude web content from nroffs
2016-04-06 08:20:27 -07:00
Simon Michael
24c2e7d471
doc: move man page source and nroff to PKG/doc/
2016-04-06 08:16:38 -07:00
Simon Michael
74a29f70bf
site: docs: cleanup
2016-04-05 16:39:58 -07:00
Simon Michael
750c4f0f31
tools: use main stackage snapshot for hakyll too
2016-04-05 16:21:45 -07:00
Simon Michael
a5d5b05b66
tools: shake cleanup, webmanual target fixup
2016-04-05 16:17:08 -07:00
Simon Michael
a0e62a1d89
tools: shake cleanup, webmanual target fixup
2016-04-05 16:17:08 -07:00
Simon Michael
2089168e7d
doc: update hledger_journal.5 man page
2016-04-05 16:17:08 -07:00
Simon Michael
eab6b110bc
tools: simplify doc filtering class names
2016-04-05 16:17:08 -07:00
Simon Michael
7163a730fd
tools: shake cleanup, webmanual target fixup
2016-04-05 16:17:08 -07:00
