site: move manual, devguide here; move out of doc/

This commit is contained in:
Simon Michael 2015-11-05 19:32:17 -08:00
parent dea1bc5ab3
commit 18f3e723ec
93 changed files with 41 additions and 44 deletions

View File

@ -120,12 +120,12 @@ SOURCEFILES:= \
CABALFILES:= \
hledger/hledger.cabal \
hledger-*/*.cabal \
doc/site/hakyll-std.cabal
site/hakyll-std.cabal
HPACKFILES:= \
hledger/package.yaml \
hledger-*/package.yaml \
doc/site/package.yaml
site/package.yaml
WEBFILES:= \
hledger-web/templates/* \
@ -860,34 +860,34 @@ $(call def-help-subsection,DOCUMENTATION:)
# \
# )
doc/site/hakyll-std hakyll-std: \
doc/site/hakyll-std.hs \
doc/site/TableOfContents.hs \
site/hakyll-std hakyll-std: \
site/hakyll-std.hs \
site/TableOfContents.hs \
$(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 \
$(call def-help,site, generate the hledger.org website with hakyll-std )
-cd doc/site; ./hakyll-std build
site-build: site/hakyll-std \
$(call def-help,site-build, generate the hledger.org website with hakyll-std )
-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
-cd doc/site; ./hakyll-std clean
# rm -rf doc/site/_site/*
-cd site; ./hakyll-std clean
# rm -rf site/_site/*
# XXX hakyll watch & preview mostly don't live-update any more
site-preview: doc/site/hakyll-std \
$(call def-help,site-preview, run a hakyll server to preview the website ) #doc/site/site
-cd doc/site; ./hakyll-std watch # -h hledger.org
site-preview: site/hakyll-std \
$(call def-help,site-preview, run a hakyll server to preview the website ) #site/site
-cd site; ./hakyll-std watch # -h hledger.org
# site-view: site \
# $(call def-help,site-view,\
# \
# )
# $(VIEWHTML) doc/site/_site/index.html
# $(VIEWHTML) site/_site/index.html
# # 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:
@ -969,25 +969,25 @@ haddock: \
# # http://www.cs.york.ac.uk/fp/darcs/hscolour/
# 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,\
# \
# )
# 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
# doc/site/api/src/hscolour.css: doc/site/api/src \
# $(call def-help,doc/site/api/src/hscolour.css,\
# site/api/src/hscolour.css: site/api/src \
# $(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: \
# $(call def-help,doc/site/api/src,\
# site/api/src: \
# $(call def-help,site/api/src,\
# \
# )
# mkdir -p doc/site/api/src
# mkdir -p site/api/src
# 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
# 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 )
%.cabal: $$(dir $$@)package.yaml \

View File

@ -1 +0,0 @@
../contributors.md

View File

@ -1 +0,0 @@
../developer-guide.md

View File

@ -1 +0,0 @@
../manual.md

View File

@ -684,18 +684,18 @@ If you're new to this process, [help.github.com](http://help.github.com) may be
- flags
- update docs
- */CHANGES
- doc/site/release-notes.md
- haddocks
- changelogs
- man pages
- doc/contributors.md
- doc/manual.md (commands, options, --help, ledger compatibility..)
- doc/site/step-by-step.md
- doc/site/how-to-*
- doc/site/faq.md (ledger compatibility)
- doc/site/installing.md
- doc/site/download.md
- doc/developer-guide.md
- site/release-notes.md
- site/manual.md (commands, options, --help, ledger compatibility..)
- site/developer-guide.md
- site/step-by-step.md
- site/how-to-*
- site/faq.md (ledger compatibility)
- site/installing.md
- site/download.md
- site/contributors.md
- doc/ANNOUNCE
- update version
@ -754,10 +754,10 @@ don't run make setversion.
2. document
- */*.cabal for affected package(s) (descriptions, tested-with, files..)
- */CHANGES for affected package(s)
- doc/site/release-notes.md
- doc/manual.md (commands, options, --help, ledger compatibility..)
- doc/site/step-by-step.md
- doc/site/how-to-*
- site/release-notes.md
- site/manual.md (commands, options, --help, ledger compatibility..)
- site/step-by-step.md
- site/how-to-*
3. test
- make unittest
- make functest
@ -812,7 +812,7 @@ The hledger project aims to produce:
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
- short blurbs: cabal files, module headers, HCAR, GSOC project, ..
- `doc/notes.org` has some old developer notes

View File

Before

Width:  |  Height:  |  Size: 61 KiB

After

Width:  |  Height:  |  Size: 61 KiB

View File

Before

Width:  |  Height:  |  Size: 56 KiB

After

Width:  |  Height:  |  Size: 56 KiB

View File

Before

Width:  |  Height:  |  Size: 318 KiB

After

Width:  |  Height:  |  Size: 318 KiB

View File

Before

Width:  |  Height:  |  Size: 63 KiB

After

Width:  |  Height:  |  Size: 63 KiB

View File

Before

Width:  |  Height:  |  Size: 127 KiB

After

Width:  |  Height:  |  Size: 127 KiB

View File

Before

Width:  |  Height:  |  Size: 54 KiB

After

Width:  |  Height:  |  Size: 54 KiB

View File

Before

Width:  |  Height:  |  Size: 219 KiB

After

Width:  |  Height:  |  Size: 219 KiB

View File

Before

Width:  |  Height:  |  Size: 165 KiB

After

Width:  |  Height:  |  Size: 165 KiB

View File

Before

Width:  |  Height:  |  Size: 31 KiB

After

Width:  |  Height:  |  Size: 31 KiB

View File

Before

Width:  |  Height:  |  Size: 185 KiB

After

Width:  |  Height:  |  Size: 185 KiB

View File

Before

Width:  |  Height:  |  Size: 158 KiB

After

Width:  |  Height:  |  Size: 158 KiB

View File

Before

Width:  |  Height:  |  Size: 103 KiB

After

Width:  |  Height:  |  Size: 103 KiB

View File

Before

Width:  |  Height:  |  Size: 48 KiB

After

Width:  |  Height:  |  Size: 48 KiB

View File

Before

Width:  |  Height:  |  Size: 41 KiB

After

Width:  |  Height:  |  Size: 41 KiB

View File

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 39 KiB

View File

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 42 KiB

View File

Before

Width:  |  Height:  |  Size: 38 KiB

After

Width:  |  Height:  |  Size: 38 KiB

View File

Before

Width:  |  Height:  |  Size: 65 KiB

After

Width:  |  Height:  |  Size: 65 KiB

View File

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 42 KiB

View File

Before

Width:  |  Height:  |  Size: 204 KiB

After

Width:  |  Height:  |  Size: 204 KiB

View File

Before

Width:  |  Height:  |  Size: 92 KiB

After

Width:  |  Height:  |  Size: 92 KiB

View File

Before

Width:  |  Height:  |  Size: 88 KiB

After

Width:  |  Height:  |  Size: 88 KiB

View File

Before

Width:  |  Height:  |  Size: 56 KiB

After

Width:  |  Height:  |  Size: 56 KiB

View File

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 42 KiB

View File

Before

Width:  |  Height:  |  Size: 101 KiB

After

Width:  |  Height:  |  Size: 101 KiB

View File

Before

Width:  |  Height:  |  Size: 30 KiB

After

Width:  |  Height:  |  Size: 30 KiB

View File

Before

Width:  |  Height:  |  Size: 128 KiB

After

Width:  |  Height:  |  Size: 128 KiB

View File

Before

Width:  |  Height:  |  Size: 56 KiB

After

Width:  |  Height:  |  Size: 56 KiB

View File

Before

Width:  |  Height:  |  Size: 68 KiB

After

Width:  |  Height:  |  Size: 68 KiB

View File

Before

Width:  |  Height:  |  Size: 57 KiB

After

Width:  |  Height:  |  Size: 57 KiB

View File

Before

Width:  |  Height:  |  Size: 49 KiB

After

Width:  |  Height:  |  Size: 49 KiB

View File

Before

Width:  |  Height:  |  Size: 32 KiB

After

Width:  |  Height:  |  Size: 32 KiB

View File

Before

Width:  |  Height:  |  Size: 68 KiB

After

Width:  |  Height:  |  Size: 68 KiB

View File

Before

Width:  |  Height:  |  Size: 58 KiB

After

Width:  |  Height:  |  Size: 58 KiB

View File

Before

Width:  |  Height:  |  Size: 3.5 KiB

After

Width:  |  Height:  |  Size: 3.5 KiB

View File

Before

Width:  |  Height:  |  Size: 4.8 KiB

After

Width:  |  Height:  |  Size: 4.8 KiB

View File

Before

Width:  |  Height:  |  Size: 144 KiB

After

Width:  |  Height:  |  Size: 144 KiB

View File

Before

Width:  |  Height:  |  Size: 26 KiB

After

Width:  |  Height:  |  Size: 26 KiB

View File

Before

Width:  |  Height:  |  Size: 84 KiB

After

Width:  |  Height:  |  Size: 84 KiB

View File

Before

Width:  |  Height:  |  Size: 6.2 KiB

After

Width:  |  Height:  |  Size: 6.2 KiB

View File

Before

Width:  |  Height:  |  Size: 1.9 KiB

After

Width:  |  Height:  |  Size: 1.9 KiB

View File

Before

Width:  |  Height:  |  Size: 3.6 KiB

After

Width:  |  Height:  |  Size: 3.6 KiB

View File

Before

Width:  |  Height:  |  Size: 209 B

After

Width:  |  Height:  |  Size: 209 B

View File

Before

Width:  |  Height:  |  Size: 2.8 KiB

After

Width:  |  Height:  |  Size: 2.8 KiB

View File

Before

Width:  |  Height:  |  Size: 867 B

After

Width:  |  Height:  |  Size: 867 B

View File

Before

Width:  |  Height:  |  Size: 668 B

After

Width:  |  Height:  |  Size: 668 B

View File

Before

Width:  |  Height:  |  Size: 673 B

After

Width:  |  Height:  |  Size: 673 B

View File

Before

Width:  |  Height:  |  Size: 1.8 KiB

After

Width:  |  Height:  |  Size: 1.8 KiB

View File

Before

Width:  |  Height:  |  Size: 2.0 KiB

After

Width:  |  Height:  |  Size: 2.0 KiB

View File

Before

Width:  |  Height:  |  Size: 2.7 KiB

After

Width:  |  Height:  |  Size: 2.7 KiB

View File

Before

Width:  |  Height:  |  Size: 3.3 KiB

After

Width:  |  Height:  |  Size: 3.3 KiB

View File

Before

Width:  |  Height:  |  Size: 3.0 KiB

After

Width:  |  Height:  |  Size: 3.0 KiB

View File

Before

Width:  |  Height:  |  Size: 2.0 KiB

After

Width:  |  Height:  |  Size: 2.0 KiB

View File

Before

Width:  |  Height:  |  Size: 70 B

After

Width:  |  Height:  |  Size: 70 B

View File

Before

Width:  |  Height:  |  Size: 326 B

After

Width:  |  Height:  |  Size: 326 B

View File

Before

Width:  |  Height:  |  Size: 326 B

After

Width:  |  Height:  |  Size: 326 B