slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: adapt apidocs: to package split, add sourcegraph: rule

Browse Source
This commit is contained in:
Simon Michael 2010-04-06 23:44:51 +00:00
parent df0350a67c
commit b5b06e5f1a
2 changed files with 17 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Makefile
View File

@ -301,7 +301,7 @@ site: push
# We munge haddock and hoogle into a rough but useful framed layout.
# For this to work the hoogle cgi must be built with base target "main".
# XXX move the framed index building into haddock: ?
apidocs: haddock hscolour #hoogle
apidocs: haddock hscolour #sourcegraph #hoogle
sed -i -e 's%^></HEAD%><base target="main"></HEAD%' website/api-doc/modules-index.html ; \
cp website/api-doc-frames.html website/api-doc/index.html ; \
# cp website/hoogle-small.html website/api-doc
@ -316,6 +316,7 @@ HADDOCK=haddock -B `ghc --print-libdir` $(subst -D,--optghc=-D,$(DEFINEFLAGS)) -
haddock:
$(HADDOCK) -o website/api-doc -h --source-module=src-%{MODULE/./-}.html --source-entity=src-%{MODULE/./-}.html#%N $(MAIN) && \
cp website/api-doc/index.html website/api-doc/modules-index.html
cd hledger-lib; cabal haddock
HSCOLOUR=HsColour -css
hscolour:
@ -325,6 +326,10 @@ hscolour:
cp website/api-doc/src-hledger.html website/api-doc/src-Main.html ; \
HsColour -print-css >website/api-doc/hscolour.css
sourcegraph:
-SourceGraph hledger.cabal
-cd hledger-lib; SourceGraph hledger-lib.cabal
#set up the hoogle web interface
#uses a hoogle source tree configured with --datadir=., patched to fix haddock urls/target frame
HOOGLESRC=/usr/local/src/hoogle

16
README2
View File

@ -24,10 +24,13 @@ hledger is free software by `Simon Michael`_ & `co.`_, released under GNU GPLv3.
**Develop**
``darcs get http://joyful.com/repos/hledger``,
`browse the repo`_,
`code docs`_,
`hackage page`_,
notes_,
benchmark_\/profile_\/heap_\/coverage_ reports
`hledger-lib api docs`_,
`hledger api docs`_,
`hledger-lib sourcegraph report`_,
`hledger sourcegraph report`_,
benchmark_\/profile_\/heap_\/coverage_ reports,
`developer notes`_
.. raw:: html
<a name="support" />
@ -67,8 +70,11 @@ hledger is free software by `Simon Michael`_ & `co.`_, released under GNU GPLv3.
.. _manual: MANUAL.html
.. _news: NEWS.html
.. _screenshots: SCREENSHOTS.html
.. _code docs: http://hledger.org/api-doc
.. _notes: http://joyful.com/darcsweb/darcsweb.cgi?r=hledger;a=plainblob;f=/NOTES
.. _hledger-lib api docs: http://joyful.com/repos/hledger/hledger-lib/dist/doc/html/hledger-lib/index.html
.. _hledger api docs: http://hledger.org/api-doc
.. _hledger-lib sourcegraph report: http://joyful.com/repos/hledger/hledger-lib/SourceGraph/hledger-lib.html
.. _hledger sourcegraph report: http://joyful.com/repos/hledger/SourceGraph/hledger.html
.. _developer notes: http://joyful.com/darcsweb/darcsweb.cgi?r=hledger;a=plainblob;f=/NOTES
.. _benchmark: http://hledger.org/profs/latest.bench
.. _profile: http://hledger.org/profs/latest.prof
.. _heap: http://hledger.org/profs/latest.ps