hledger/doc
Simon Michael 91d5308783 ;tools: Shake cmdhelp -> cmddocs, now runs hledger to update flag docs
Now, updating a command's docs (for hledger manual and for --help) requires
running the command (with stack exec -- hledger). The sequence is now
a bit recursive:

1. Run hledger CMD -h to update CMD.md with the latest cmdargs help output for CMD's flags.
   CMD.md is included in the hledger manual, when rendering that.
2. Convert CMD.md to CMD.txt, with pandoc.
3. Build hledger, embedding CMD.txt for cmdargs to use as -h output.

This need only be done after changing command docs or flags, and
hopefully won't be a hassle. Shake cmddocs now shows progress output
to make things clearer.
2024-06-07 14:35:31 -07:00
..
haskellerz Add 'doc/haskellerz/' from commit '79beb34b900b5d35b065e145d6200d227de16945' 2021-04-30 13:03:44 -10:00
hcar doc: hcar: link to old entry 2018-05-16 17:58:17 -07:00
mockups ;doc: mockups: move lots to website 2023-01-25 11:37:01 -10:00
profs git ignore profs, .hpc files 2014-10-31 16:33:55 -07:00
tldr ;doc: sync with tldr docs 2024-05-29 17:30:50 -10:00
ACHIEVEMENTS.md ;doc: dev: updates 2023-04-14 20:08:37 -10:00
ANNOUNCE ;doc: merge 1.34 release docs 2024-06-01 14:13:57 -10:00
ANNOUNCE.masto ;doc: merge 1.34 release docs 2024-06-01 14:13:57 -10:00
BENCHMARKS.md ;doc: use ``cli not ``shell for command-line examples 2023-11-26 08:30:04 -10:00
CHANGELOGS.md ;doc: CHANGELOGS: update 2023-06-01 16:30:46 -10:00
CLIMATE.md ;doc: rename/move CLIMATE here from site repo 2024-04-15 21:14:31 -10:00
CODE.md ;doc: dev: update 'make' mentions to 'just' 2024-04-24 08:39:35 -10:00
COMMITS.md ;doc: dev: update 'make' mentions to 'just' 2024-04-24 08:39:35 -10:00
common.m4 ;doc: cli: simplify, use generic help flags again 2024-05-31 19:54:18 -10:00
CONTRIBUTING.md ;doc: The flattening: adapt to the site's depth-1 page TOCs 2024-05-22 13:06:08 -10:00
CREDITS.md ;doc: dev: update 'make' mentions to 'just' 2024-04-24 08:39:35 -10:00
DECISIONS.md ;doc: move plugin types table to Scripting hledger page 2023-01-21 10:19:03 -10:00
dev.md ;doc: restart Developer FAQ 2024-05-01 08:48:28 -10:00
DEVFAQ.md ;doc: The flattening: adapt to the site's depth-1 page TOCs 2024-05-22 13:06:08 -10:00
DEVWORKFLOWS.md ;doc: dev: update 'make' mentions to 'just' 2024-04-24 08:39:35 -10:00
DOCS.md ;doc: dev: update 'make' mentions to 'just' 2024-04-24 08:39:35 -10:00
EXAMPLES.md ;doc: dev: update 'make' mentions to 'just' 2024-04-24 08:39:35 -10:00
FILES.md ;doc: dev: update 'make' mentions to 'just' 2024-04-24 08:39:35 -10:00
FINANCE.md ;doc: move most dev docs to doc/ 2022-12-04 11:22:05 -08:00
ghrelnotes ;doc: ghrelnotes: cleanups 2024-06-02 07:10:24 -10:00
investment-accounting-features.md ;doc: move dev docs, mockups, investment features pages from site repo 2024-04-15 20:10:39 -10:00
ISSUES.md ;doc:ISSUES: cleanup 2024-01-27 20:26:02 -10:00
JUST-MAKE-SHAKE.md ;doc: dev: tweak title 2024-05-01 08:48:28 -10:00
manpage.nroff ;imp:doc:manuals: consolidate, update BUGS sections 2023-05-26 06:38:27 -10:00
MOCKUPS.md ;doc: MOCKUPS: heading 2024-04-15 21:02:06 -10:00
PULLREQUESTS.md ;doc: small fixes 2024-03-17 10:54:02 -10:00
README ;doc: merge doc/README with dev docs 2021-09-27 02:20:44 -10:00
REGRESSIONS.md ;doc: REGRESSIONS: edits 2024-05-01 19:16:52 -10:00
RELEASING.canvas ;doc: RELEASING diagram: updates 2023-06-06 07:35:36 -10:00
RELEASING.md ;tools: Shake cmdhelp -> cmddocs, now runs hledger to update flag docs 2024-06-07 14:35:31 -07:00
RELEASING.png ;doc: RELEASING updates 2023-04-07 14:33:11 -10:00
relnotes.md ;doc: relnotes: 1.34: unwrap long lines 2024-06-01 15:50:51 -10:00
REPOS.md ;doc: REPOS, FILES 2022-12-04 12:16:53 -08:00
ROADMAP.md ;doc: update ROADMAP 2024-04-14 20:12:13 -10:00
TESTS.md ;doc: dev: update 'make' mentions to 'just' 2024-04-24 08:39:35 -10:00
TODO.md ;doc: drop BACKLOG, deprecate TODO 2024-04-14 20:11:44 -10:00
VERSIONNUMBERS.md ;doc: dev: update 'make' mentions to 'just' 2024-04-24 08:39:35 -10:00

Support files used for generating project documentation,
and various archived documentation artifacts.

For more about hledger's docs, see ../DOCS.md.