Commit Graph

295 Commits

Author SHA1 Message Date
Simon Michael
99f52f719a site: new system for generating versioned docs 2017-01-04 17:02:22 -08:00
Simon Michael
04557613b1 fix Shake.hs 2016-12-30 15:43:47 -08:00
Simon Michael
3bfc5f7743 tools: build shake threaded for entr 2016-12-30 14:36:27 -08:00
Simon Michael
1930213407 tools: just run Shake.hs to compile it 2016-12-29 11:33:34 -08:00
Simon Michael
eaf8853a9f tools: hakyll isn't in lts 7, use nightly for hakyll-std
Also compile it when run interpreted.
2016-12-29 11:33:34 -08:00
Simon Michael
08244f0747 shake: workaround for a weird error running hakyll-std 2016-10-29 10:51:43 -07:00
Simon Michael
91686b400b shake: comments 2016-10-29 10:23:28 -07:00
Simon Michael
79dfa308fc shake: compile now installs required libs 2016-10-29 09:42:48 -07:00
Simon Michael
d4844b621e shake: don't Clean generated man files
It caused hpack to omit them from cabal files.
2016-10-29 09:41:50 -07:00
Simon Michael
7d4a1f2399 tools: make/shake cleanups 2016-10-28 11:15:10 -07:00
Simon Michael
1953f20136 shake: small comment fix 2016-10-17 08:53:38 -07:00
Simon Michael
5a58298ee3 shake: ensure hakyll-std's required libs are up to date 2016-08-09 18:28:25 -07:00
Simon Michael
1a29d9cc02 doc: better doc version indicator, on 0.27 manual too #385, #387 2016-08-07 08:44:06 -07:00
Simon Michael
68a1a8687a doc: generate really plain text manuals
Drop the nice ansi highlighting that won't work everywhere,
the unpredictable unicode hyphens, etc.
2016-06-11 21:34:20 -07:00
Simon Michael
2f130fe10b shake: rename site target to website
Fixes a new shake error, perhaps related to
https://github.com/ndmitchell/shake/issues/440
2016-05-28 12:10:51 -07:00
Simon Michael
3d129f6d31 shake: also generate info manuals 2016-04-18 17:54:55 -07:00
Simon Michael
4c291dc54e doc: use macros not divs to select web/man content
Use slightly clearer m4 macros instead of special divs to mark content
as web only/man only. The temporary doc/*.md files are no longer needed,
slightly more redundant work is done.
2016-04-16 10:09:51 -07:00
Simon Michael
6529daf20c site: ensure 0.27 manual is in place for links
Stripping hledger- from the link fragment with patsubst isn't working.
2016-04-16 05:55:16 -07:00
Simon Michael
778b78e0b9 site: consistent toc styling 2016-04-16 05:52:20 -07:00
Simon Michael
6a97a246dd doc: use m4 for all manuals, shake cleanup 2016-04-16 03:50:30 -07:00
Simon Michael
8a98e0af20 shake: comments 2016-04-15 16:08:02 -07:00
Simon Michael
c773a81447 shake: update txt man pages when man pages change 2016-04-13 22:47:19 -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
588f36d662 rename timelog format to timeclock 2016-04-12 21:13:19 -07:00
Simon Michael
bf4e6c314c shake: use default build dir 2016-04-12 20:32:01 -07:00
Simon Michael
5ef67e0d4d doc: remove old manual. No more duplication! #292 2016-04-12 20:29:29 -07:00
Simon Michael
db96d54ec0 doc: separate docs target that skips the site 2016-04-10 12:11:19 -07:00
Simon Michael
6a019eedc6 shake: also build/clean hakyll-std and website 2016-04-09 14:24:33 -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
775ab2fd4e site: simplify man page uris; shake cleanups 2016-04-08 07:01:40 -07:00
Simon Michael
33e2ca927f doc: improve new combined manual, cleanups 2016-04-07 21:58:42 -07:00
Simon Michael
443b870481 site: fix man page TOCs, add combined man page 2016-04-07 08:55:21 -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
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
7163a730fd tools: shake cleanup, webmanual target fixup 2016-04-05 16:17:08 -07:00
Simon Michael
9b492325da tools: rename pandoc filters 2016-04-05 16:17:08 -07:00
Simon Michael
7e517a4cda tools: shake cleanup, webmanual target 2016-04-05 16:17:08 -07:00
Simon Michael
099870e96a tools: shake file requires pandoc, filters use current snapshot 2016-04-05 16:17:08 -07:00
Simon Michael
df3cb6d334 tools: use latest pandoc, avoiding SoftBreak error
Require a recent snapshot with the latest pandoc-types for the pandoc
filters (may be different from the snapshot used to build hledger).
2016-04-05 16:17:08 -07:00
Simon Michael
bded4b9221 tools: expand shake file, show help by default 2016-04-05 06:59:52 -07:00