Simon Michael
297a831387
;site: symlink the main README.md, render it as part of the site
...
The top-level README.md is usually seen when browsing github or the
cloned source - not on the website - but now we render it as part of
the website to facilitate previewing it locally (with make
site-watch).
As a side effect of symlinking it into site/, it might override site/'s
README when browsing that directory on github.
[ci skip]
2019-05-29 22:33:25 -07:00
Simon Michael
a7ffa6108b
;site: download: reorganise with binaries at top, cleanup, add TOC
...
[ci skip]
2019-05-17 20:59:44 -07:00
Simon Michael
a8599d991e
shake: show htmlmanuals target in help
...
[ci skip]
2019-05-09 12:23:11 -07:00
Simon Michael
688bdf86ec
site: symlink CONTRIBUTING.md instead of copying, less confusing
...
[ci skip]
2019-04-25 08:10:06 -07:00
Simon Michael
93a7dc3461
site: don't render /README.md as part of site, not used & confusing
...
[ci skip]
2019-04-25 08:05:57 -07:00
Simon Michael
e8eee8e7c7
; shake comment
2019-03-21 10:23:41 -07:00
Simon Michael
a34892f358
;shake hledgerorg: tweak home page commit message
2019-03-08 19:59:45 -08:00
Simon Michael
7b94b0c9b2
make site: log to site.log again
...
[ci skip]
2019-03-06 09:30:54 -08:00
Simon Michael
e5f3dd1a75
shake site: also commit & push home page when wiki links change
...
[ci skip]
2019-03-06 09:30:54 -08:00
Simon Michael
7af5ee4863
tools: move site.sh into shake; stop running just-pushed shakefile
...
Running the just pushed Shake.hs was too insecure.
[ci skip]
2019-03-06 09:30:54 -08:00
Simon Michael
9333cfe28b
shake: don't echo commands by default
...
[ci skip]
2019-03-06 08:48:48 -08:00
Simon Michael
247cb4e1ad
shake: clean up docs
2019-03-05 19:21:45 -08:00
Simon Michael
f9aa71caf1
shake commandhelp: don't generate a txt for the README ( #981 )
...
[ci skip]
2019-03-04 11:38:11 -08:00
Simon Michael
0984a8cd41
shake: add 1.14 to web manual versions
...
[ci skip]
2019-03-01 18:17:35 -08:00
Simon Michael
ff7395bb32
Shake clean: don't remove version-controlled command help files
...
[ci skip]
2019-02-26 10:14:29 -08:00
Simon Michael
2364a53f49
site: add table of contents to all wiki pages with 2+ headings
...
[ci skip]
2019-02-11 14:12:48 -08:00
Simon Michael
3aad6696c9
shake: fix old manuals' deps; don't build them by default; refactor
...
[ci skip]
2019-02-11 13:07:06 -08:00
Simon Michael
d0996213cd
site: wiki pages: get links from Home; prepend page name headings
...
[ci skip]
2019-02-09 19:28:53 -08:00
Simon Michael
aeb7d58c31
shake: cleanup
2019-02-09 19:28:53 -08:00
Simon Michael
d79bd77feb
site: wiki integration - render wiki pages within main site
...
The github wiki pages are now rendered as part of the website's static
content, like the main site pages (and using the same pandoc markdown).
Building the site now requires that a copy of the wiki is checked out
under wiki/.
Github wiki links are converted to suitable relative links,
in all pages (not just wiki pages).
`make site/index.md-push`, which updated the wiki links on the website
home page and committed/pushed it, is now `./Shake site/index.md`, and
doesn't commit/push.
Shake.hs now also depends on the `regex` package.
[ci skip]
2019-02-09 19:28:53 -08:00
Simon Michael
ce2ef2497a
shake: also generate static html from wiki pages
...
A copy of the github wiki is assumed to be checked out in ./wiki/
[ci skip]
2019-02-09 19:28:53 -08:00
Simon Michael
de69456b8f
shake: fix the fix
...
[ci skip]
2019-02-05 11:56:51 -08:00
Simon Michael
2bd0d27976
shake: be GNU sed compatible, fixing defs.m4 updating
...
[ci skip]
2019-02-05 11:55:52 -08:00
Simon Michael
f4e237afd6
shake [PKG/]CHANGES.md-finalise : sets final changelog heading
...
Replaces an interim (commit hash) heading with a release heading based
on the .version file and today's date.
[ci skip]
2019-02-05 07:31:06 -08:00
Simon Michael
18ffa65168
tools: move setversion to shake, use PKG/.version, set upper bounds
...
./Shake setversion will now propagate the version number in each
package's .version file, to all the places in that package where it's
needed (ie the defs.m4 file and multiple places in the package.yaml
file. Also it now updates upper bounds on other hledger packages
to the next major version. (The new lower/upper bounds may not always
be what's desired, manual review required.)
[ci skip]
2019-02-04 18:47:27 -08:00
Simon Michael
bf6acf52ef
doc: allow per-package m4 defs, to override things like version
...
[ci skip]
2019-02-04 15:18:51 -08:00
Simon Michael
3f4473639a
doc: lib.m4 -> common.m4; restore required _FLAGS_ macro
...
[ci skip]
2019-02-04 14:44:35 -08:00
Simon Michael
384c555f99
make, shake: refer to each other's help
...
[ci skip]
2019-02-03 17:01:57 -08:00
Simon Michael
40d1572359
bump version to 1.13
2019-02-01 17:19:19 -08:00
Simon Michael
f1d4b39146
shake: update help, clean/Clean output
...
[ci skip]
2019-02-01 10:38:14 -08:00
Simon Michael
89bb4816c6
shake: move changelog scripts to Shake, enhance
...
New shake targets:
./Shake changelogs
./Shake CHANGES.md
./Shake CHANGES.md-dry
./Shake PKG/CHANGES.md
./Shake PKG/CHANGES.md-dry
Enhancements:
- removes the changelog's previous top heading
- ignores commits like "changelog", "doc: update changelogs"..
- does not write temporary files
- dry run mode
[ci skip]
2019-02-01 10:36:49 -08:00
Simon Michael
5435150d39
doc: don't use sed; fix accidental dedenting of some lists ( #961 )
...
The sed code was showing an error message, not too precise.
Pandoc's lua filters to the rescue!
[ci skip]
2019-01-31 08:34:49 -08:00
Simon Michael
c8246e7323
cli: command help: reduce width, line wrapping
...
cmdargs wraps any lines longer than 78 characters. To (mostly) avoid
this, we now display verbatim blocks unindented, and some of
register's examples have been altered to make them fit.
2019-01-30 17:58:13 -08:00
Simon Michael
fa996828b1
shake: fix build's doc deps; cleanup
...
[ci skip]
2019-01-30 12:45:09 -08:00
Simon Michael
4c5ac4dd06
cli: fix command help, really render as plain text
...
pandoc thinks .txt is a markdown file apparently
2019-01-30 12:44:10 -08:00
Simon Michael
0628b648f3
shake: Shake PKG (or Shake build) builds packages plus their docs
...
"stack build hledger" will not notice changes in documentation source
files (like hledger/Hledger/Cli/Commands/Add.md or
hledger-lib/hledger_journal.m4.md), but "./Shake hledger" will.
"./Shake build" builds all the packages, like a doc-aware "stack build".
2019-01-30 10:41:39 -08:00
Simon Michael
5b6c441698
shake: manuals: also depend on new command doc files
2019-01-26 16:33:35 -08:00
Simon Michael
789e8be280
shake: update required tools list
...
[ci skip]
2019-01-25 07:04:16 -08:00
Simon Michael
eac15369f2
doc: stop pandoc typography conversions in html manuals ( #954 )
...
Eg: -- was being rendered as en-dash.
[ci skip]
2019-01-24 15:29:56 -08:00
Simon Michael
5c5e404df6
doc: contributing: add TOC
2019-01-19 17:31:03 -08:00
Simon Michael
d095e6a06b
shake: also clean the copied README/CONTRIBUTING
...
[ci skip]
2019-01-19 15:47:39 -08:00
Simon Michael
5000c6ac6a
site: forcing lower-case URIs is a hassle; add redirects for now
...
[ci skip]
2019-01-19 15:42:43 -08:00
Simon Michael
240406706a
move the wiki dev docs into CONTRIBUTING.md. Markdown for now. #920
...
[ci skip]
2019-01-19 15:31:21 -08:00
Simon Michael
9f057731c3
shake: common pandoc opts
...
[ci skip]
2019-01-19 15:31:21 -08:00
Simon Michael
b7e64440b2
shake: cleanups, document
...
[ci skip]
2019-01-19 15:31:21 -08:00
Simon Michael
1077ccf70c
shake: cleanups
...
[ci skip]
2019-01-19 15:31:21 -08:00
Simon Michael
ef0f4cd4d2
shake: disable pandoc's tex math extension to silence relnote warning
...
[ci skip]
2018-12-03 09:21:05 -08:00
Simon Michael
67d7c82e9f
bump version to 1.12
2018-12-02 17:20:34 -08:00
Simon Michael
e6556e4760
site: shake: also generate the 1.11 web manual
...
[ci skip]
2018-10-06 09:48:03 -10:00
Simon Michael
7f1b34ea1d
doc: fix generation of 1.10 manual html
2018-07-04 13:22:09 +01:00