site: move manual, devguide here; move out of doc/
52
Makefile
@ -120,12 +120,12 @@ SOURCEFILES:= \
|
|||||||
CABALFILES:= \
|
CABALFILES:= \
|
||||||
hledger/hledger.cabal \
|
hledger/hledger.cabal \
|
||||||
hledger-*/*.cabal \
|
hledger-*/*.cabal \
|
||||||
doc/site/hakyll-std.cabal
|
site/hakyll-std.cabal
|
||||||
|
|
||||||
HPACKFILES:= \
|
HPACKFILES:= \
|
||||||
hledger/package.yaml \
|
hledger/package.yaml \
|
||||||
hledger-*/package.yaml \
|
hledger-*/package.yaml \
|
||||||
doc/site/package.yaml
|
site/package.yaml
|
||||||
|
|
||||||
WEBFILES:= \
|
WEBFILES:= \
|
||||||
hledger-web/templates/* \
|
hledger-web/templates/* \
|
||||||
@ -860,34 +860,34 @@ $(call def-help-subsection,DOCUMENTATION:)
|
|||||||
# \
|
# \
|
||||||
# )
|
# )
|
||||||
|
|
||||||
doc/site/hakyll-std hakyll-std: \
|
site/hakyll-std hakyll-std: \
|
||||||
doc/site/hakyll-std.hs \
|
site/hakyll-std.hs \
|
||||||
doc/site/TableOfContents.hs \
|
site/TableOfContents.hs \
|
||||||
$(call def-help,hakyll-std, build a generic hakyll site builder script )
|
$(call def-help,hakyll-std, build a generic hakyll site builder script )
|
||||||
cd doc/site; stack ghc hakyll-std
|
cd site; stack ghc hakyll-std
|
||||||
|
|
||||||
site: doc/site/hakyll-std \
|
site-build: site/hakyll-std \
|
||||||
$(call def-help,site, generate the hledger.org website with hakyll-std )
|
$(call def-help,site-build, generate the hledger.org website with hakyll-std )
|
||||||
-cd doc/site; ./hakyll-std build
|
-cd site; ./hakyll-std build
|
||||||
|
|
||||||
site-clean: doc/site/hakyll-std \
|
site-clean: site/hakyll-std \
|
||||||
$(call def-help,site-clean, remove hakyll-generated files (& take down the website) ) #cleanolddocs
|
$(call def-help,site-clean, remove hakyll-generated files (& take down the website) ) #cleanolddocs
|
||||||
-cd doc/site; ./hakyll-std clean
|
-cd site; ./hakyll-std clean
|
||||||
# rm -rf doc/site/_site/*
|
# rm -rf site/_site/*
|
||||||
|
|
||||||
# XXX hakyll watch & preview mostly don't live-update any more
|
# XXX hakyll watch & preview mostly don't live-update any more
|
||||||
site-preview: doc/site/hakyll-std \
|
site-preview: site/hakyll-std \
|
||||||
$(call def-help,site-preview, run a hakyll server to preview the website ) #doc/site/site
|
$(call def-help,site-preview, run a hakyll server to preview the website ) #site/site
|
||||||
-cd doc/site; ./hakyll-std watch # -h hledger.org
|
-cd site; ./hakyll-std watch # -h hledger.org
|
||||||
|
|
||||||
# site-view: site \
|
# site-view: site \
|
||||||
# $(call def-help,site-view,\
|
# $(call def-help,site-view,\
|
||||||
# \
|
# \
|
||||||
# )
|
# )
|
||||||
# $(VIEWHTML) doc/site/_site/index.html
|
# $(VIEWHTML) site/_site/index.html
|
||||||
|
|
||||||
# # site-auto:
|
# # site-auto:
|
||||||
# # cd doc/site; $(AUTOBUILD) site.hs -o site $(PREFERMACUSRLIBFLAGS) --run preview
|
# # cd site; $(AUTOBUILD) site.hs -o site $(PREFERMACUSRLIBFLAGS) --run preview
|
||||||
|
|
||||||
# # ensure some old doc versions are in place:
|
# # ensure some old doc versions are in place:
|
||||||
|
|
||||||
@ -969,25 +969,25 @@ haddock: \
|
|||||||
|
|
||||||
# # http://www.cs.york.ac.uk/fp/darcs/hscolour/
|
# # http://www.cs.york.ac.uk/fp/darcs/hscolour/
|
||||||
# HSCOLOUR=HsColour -css
|
# HSCOLOUR=HsColour -css
|
||||||
# hscolour: doc/site/api/src doc/site/api/src/hscolour.css \
|
# hscolour: site/api/src site/api/src/hscolour.css \
|
||||||
# $(call def-help,hscolour,\
|
# $(call def-help,hscolour,\
|
||||||
# \
|
# \
|
||||||
# )
|
# )
|
||||||
# for f in $(HADDOCKSOURCEFILES); do \
|
# for f in $(HADDOCKSOURCEFILES); do \
|
||||||
# $(HSCOLOUR) -anchor $$f -odoc/site/api/src/`echo $$f | sed -e's%[^/]*/%%' | sed -e's%/%-%g' | sed -e's%\.hs$$%.html%'` ; \
|
# $(HSCOLOUR) -anchor $$f -osite/api/src/`echo $$f | sed -e's%[^/]*/%%' | sed -e's%/%-%g' | sed -e's%\.hs$$%.html%'` ; \
|
||||||
# done
|
# done
|
||||||
|
|
||||||
# doc/site/api/src/hscolour.css: doc/site/api/src \
|
# site/api/src/hscolour.css: site/api/src \
|
||||||
# $(call def-help,doc/site/api/src/hscolour.css,\
|
# $(call def-help,site/api/src/hscolour.css,\
|
||||||
# \
|
# \
|
||||||
# )
|
# )
|
||||||
# $(HSCOLOUR) -print-css >doc/site/api/src/hscolour.css
|
# $(HSCOLOUR) -print-css >site/api/src/hscolour.css
|
||||||
|
|
||||||
# doc/site/api/src: \
|
# site/api/src: \
|
||||||
# $(call def-help,doc/site/api/src,\
|
# $(call def-help,site/api/src,\
|
||||||
# \
|
# \
|
||||||
# )
|
# )
|
||||||
# mkdir -p doc/site/api/src
|
# mkdir -p site/api/src
|
||||||
|
|
||||||
# sourcegraph: \
|
# sourcegraph: \
|
||||||
# $(call def-help,sourcegraph,\
|
# $(call def-help,sourcegraph,\
|
||||||
@ -1358,7 +1358,7 @@ $(call def-help-subsection,MISCELLANEOUS:)
|
|||||||
|
|
||||||
# XXX enable for all cabal files when hpack is a little better
|
# XXX enable for all cabal files when hpack is a little better
|
||||||
# gencabalfiles: $$(CABALFILES)
|
# gencabalfiles: $$(CABALFILES)
|
||||||
gencabalfiles: doc/site/hakyll-std.cabal \
|
gencabalfiles: site/hakyll-std.cabal \
|
||||||
$(call def-help,gencabalfiles, regenerate cabal files from their package.yaml definitions )
|
$(call def-help,gencabalfiles, regenerate cabal files from their package.yaml definitions )
|
||||||
|
|
||||||
%.cabal: $$(dir $$@)package.yaml \
|
%.cabal: $$(dir $$@)package.yaml \
|
||||||
|
@ -1 +0,0 @@
|
|||||||
../contributors.md
|
|
@ -1 +0,0 @@
|
|||||||
../developer-guide.md
|
|
@ -1 +0,0 @@
|
|||||||
../manual.md
|
|
0
doc/site/.gitignore → site/.gitignore
vendored
@ -684,18 +684,18 @@ If you're new to this process, [help.github.com](http://help.github.com) may be
|
|||||||
- flags
|
- flags
|
||||||
|
|
||||||
- update docs
|
- update docs
|
||||||
- */CHANGES
|
|
||||||
- doc/site/release-notes.md
|
|
||||||
- haddocks
|
- haddocks
|
||||||
|
- changelogs
|
||||||
- man pages
|
- man pages
|
||||||
- doc/contributors.md
|
- site/release-notes.md
|
||||||
- doc/manual.md (commands, options, --help, ledger compatibility..)
|
- site/manual.md (commands, options, --help, ledger compatibility..)
|
||||||
- doc/site/step-by-step.md
|
- site/developer-guide.md
|
||||||
- doc/site/how-to-*
|
- site/step-by-step.md
|
||||||
- doc/site/faq.md (ledger compatibility)
|
- site/how-to-*
|
||||||
- doc/site/installing.md
|
- site/faq.md (ledger compatibility)
|
||||||
- doc/site/download.md
|
- site/installing.md
|
||||||
- doc/developer-guide.md
|
- site/download.md
|
||||||
|
- site/contributors.md
|
||||||
- doc/ANNOUNCE
|
- doc/ANNOUNCE
|
||||||
|
|
||||||
- update version
|
- update version
|
||||||
@ -754,10 +754,10 @@ don't run make setversion.
|
|||||||
2. document
|
2. document
|
||||||
- */*.cabal for affected package(s) (descriptions, tested-with, files..)
|
- */*.cabal for affected package(s) (descriptions, tested-with, files..)
|
||||||
- */CHANGES for affected package(s)
|
- */CHANGES for affected package(s)
|
||||||
- doc/site/release-notes.md
|
- site/release-notes.md
|
||||||
- doc/manual.md (commands, options, --help, ledger compatibility..)
|
- site/manual.md (commands, options, --help, ledger compatibility..)
|
||||||
- doc/site/step-by-step.md
|
- site/step-by-step.md
|
||||||
- doc/site/how-to-*
|
- site/how-to-*
|
||||||
3. test
|
3. test
|
||||||
- make unittest
|
- make unittest
|
||||||
- make functest
|
- make functest
|
||||||
@ -812,7 +812,7 @@ The hledger project aims to produce:
|
|||||||
|
|
||||||
Project documentation lives in a number of places:
|
Project documentation lives in a number of places:
|
||||||
|
|
||||||
- `doc/*.md` and `doc/site/*.md` form the hledger.org website, which is generated with hakyll[-std] and pandoc
|
- `site/*.md` is the hledger.org website content, which is generated with hakyll[-std] and pandoc
|
||||||
- haddock documentation in the code appears on Hackage
|
- haddock documentation in the code appears on Hackage
|
||||||
- short blurbs: cabal files, module headers, HCAR, GSOC project, ..
|
- short blurbs: cabal files, module headers, HCAR, GSOC project, ..
|
||||||
- `doc/notes.org` has some old developer notes
|
- `doc/notes.org` has some old developer notes
|
Before Width: | Height: | Size: 61 KiB After Width: | Height: | Size: 61 KiB |
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 56 KiB |
Before Width: | Height: | Size: 318 KiB After Width: | Height: | Size: 318 KiB |
Before Width: | Height: | Size: 63 KiB After Width: | Height: | Size: 63 KiB |
Before Width: | Height: | Size: 127 KiB After Width: | Height: | Size: 127 KiB |
Before Width: | Height: | Size: 54 KiB After Width: | Height: | Size: 54 KiB |
Before Width: | Height: | Size: 219 KiB After Width: | Height: | Size: 219 KiB |
Before Width: | Height: | Size: 165 KiB After Width: | Height: | Size: 165 KiB |
Before Width: | Height: | Size: 31 KiB After Width: | Height: | Size: 31 KiB |
Before Width: | Height: | Size: 185 KiB After Width: | Height: | Size: 185 KiB |
Before Width: | Height: | Size: 158 KiB After Width: | Height: | Size: 158 KiB |
Before Width: | Height: | Size: 103 KiB After Width: | Height: | Size: 103 KiB |
Before Width: | Height: | Size: 48 KiB After Width: | Height: | Size: 48 KiB |
Before Width: | Height: | Size: 41 KiB After Width: | Height: | Size: 41 KiB |
Before Width: | Height: | Size: 39 KiB After Width: | Height: | Size: 39 KiB |
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 42 KiB |
Before Width: | Height: | Size: 38 KiB After Width: | Height: | Size: 38 KiB |
Before Width: | Height: | Size: 65 KiB After Width: | Height: | Size: 65 KiB |
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 42 KiB |
Before Width: | Height: | Size: 204 KiB After Width: | Height: | Size: 204 KiB |
Before Width: | Height: | Size: 92 KiB After Width: | Height: | Size: 92 KiB |
Before Width: | Height: | Size: 88 KiB After Width: | Height: | Size: 88 KiB |
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 56 KiB |
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 42 KiB |
Before Width: | Height: | Size: 101 KiB After Width: | Height: | Size: 101 KiB |
Before Width: | Height: | Size: 30 KiB After Width: | Height: | Size: 30 KiB |
Before Width: | Height: | Size: 128 KiB After Width: | Height: | Size: 128 KiB |
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 56 KiB |
Before Width: | Height: | Size: 68 KiB After Width: | Height: | Size: 68 KiB |
Before Width: | Height: | Size: 57 KiB After Width: | Height: | Size: 57 KiB |
Before Width: | Height: | Size: 49 KiB After Width: | Height: | Size: 49 KiB |
Before Width: | Height: | Size: 32 KiB After Width: | Height: | Size: 32 KiB |
Before Width: | Height: | Size: 68 KiB After Width: | Height: | Size: 68 KiB |
Before Width: | Height: | Size: 58 KiB After Width: | Height: | Size: 58 KiB |
Before Width: | Height: | Size: 3.5 KiB After Width: | Height: | Size: 3.5 KiB |
Before Width: | Height: | Size: 4.8 KiB After Width: | Height: | Size: 4.8 KiB |
Before Width: | Height: | Size: 144 KiB After Width: | Height: | Size: 144 KiB |
Before Width: | Height: | Size: 26 KiB After Width: | Height: | Size: 26 KiB |
Before Width: | Height: | Size: 84 KiB After Width: | Height: | Size: 84 KiB |
Before Width: | Height: | Size: 6.2 KiB After Width: | Height: | Size: 6.2 KiB |
Before Width: | Height: | Size: 1.9 KiB After Width: | Height: | Size: 1.9 KiB |
Before Width: | Height: | Size: 3.6 KiB After Width: | Height: | Size: 3.6 KiB |
Before Width: | Height: | Size: 209 B After Width: | Height: | Size: 209 B |
Before Width: | Height: | Size: 2.8 KiB After Width: | Height: | Size: 2.8 KiB |
Before Width: | Height: | Size: 867 B After Width: | Height: | Size: 867 B |
Before Width: | Height: | Size: 668 B After Width: | Height: | Size: 668 B |
Before Width: | Height: | Size: 673 B After Width: | Height: | Size: 673 B |
Before Width: | Height: | Size: 1.8 KiB After Width: | Height: | Size: 1.8 KiB |
Before Width: | Height: | Size: 2.0 KiB After Width: | Height: | Size: 2.0 KiB |
Before Width: | Height: | Size: 2.7 KiB After Width: | Height: | Size: 2.7 KiB |
Before Width: | Height: | Size: 3.3 KiB After Width: | Height: | Size: 3.3 KiB |
Before Width: | Height: | Size: 3.0 KiB After Width: | Height: | Size: 3.0 KiB |
Before Width: | Height: | Size: 2.0 KiB After Width: | Height: | Size: 2.0 KiB |
Before Width: | Height: | Size: 70 B After Width: | Height: | Size: 70 B |
Before Width: | Height: | Size: 326 B After Width: | Height: | Size: 326 B |
Before Width: | Height: | Size: 326 B After Width: | Height: | Size: 326 B |