Commit graph

262 commits

Author SHA1 Message Date
Craig Earls
5d1971ee51 Added Huququ'llah calculation back in.
Example was inadvertantly removed
while writing the Automated Transaction section.
2013-01-25 07:26:55 -07:00
Johann Klähn
de128c9481 do not auto-build documentation
Use 'ninja doc' or 'make doc' instead.
2013-01-19 23:27:08 +01:00
Johann Klähn
54c14f9770 improve doxygen build logic
Doxygen will only be called when the 'doc' target is built
and one of its input files has changed.
2013-01-19 23:05:17 +01:00
Johann Klähn
b66c19b1f8 doxygen: enable search and folding 2013-01-19 13:27:15 +01:00
Johann Klähn
d5323000ca update Doxyfile.in (using doxygen -u) 2013-01-19 13:24:29 +01:00
Johann Klähn
252bc9bcf5 only run doxygen once
To update the documentation run `ninja doxygen` or `make doxygen`.
2013-01-19 13:22:59 +01:00
John Wiegley
23483b7973 On the Mac, texi2pdf doesn't have a --tidy option 2013-01-16 17:40:39 -06:00
Johann Klähn
b13f0c33c3 repair doxygen support 2013-01-14 23:39:34 +01:00
John Wiegley
3af432d330 Merge pull request #120 from kljohann/cmake.docs
fix issue for separate build dir
2013-01-14 14:04:00 -08:00
Johann Klähn
dd105fecd7 fix issue for separate build dir 2013-01-14 22:59:35 +01:00
John Wiegley
bf8b7e47e6 Merge pull request #119 from kljohann/cmake.docs
convert doc/Makefile to CMake
2013-01-14 12:44:08 -08:00
Johann Klähn
c88862fd66 convert doc/Makefile to CMake
CMake will build the pdf version of the manual if texi2pdf is installed.
It will be installed to DOCDIR/ledger{,3}.pdf, for example
/usr/local/share/ledger/ledger3.pdf.
Also, the man page will be installed to MANDIR/man1/ledger.1

The option BUILD_DOCS is now on by default.

A new option BUILD_WEB_DOCS is used to toggle the generation
of the html version of the manual and the man page (off by default).

All this is added to the 'doc' make target.
2013-01-14 21:35:26 +01:00
Simon Michael
0790920424 Merge branch 'next' of github.com:ledger/ledger into next 2013-01-11 10:12:42 -08:00
Simon Michael
ea09a8d507 escape @ characters properly so they show up 2013-01-11 10:07:58 -08:00
Karl Fogel
2823c99107 Update obsolete wording in documentation for 'year' command directive. 2012-12-16 15:31:32 -06:00
Alexis Hildebrandt
49983e2870 Correct typos 2012-11-10 11:57:34 +01:00
Craig Earls
dc24ea7217 Fixe } bug 2012-11-06 14:03:49 -07:00
Craig Earls
71ecd4ef79 re-fixed draft and lisp command documentation 2012-11-01 16:03:58 -07:00
Craig Earls
0ff33003e8 Minor grammatical fixes 2012-10-26 20:13:20 -07:00
Craig Earls
bd3c13e2a2 Documented removal of draft and lisp commands in the 2.6 changes chapter 2012-10-26 10:49:22 -07:00
Craig Earls
e3cd1045d5 Bugs 726 and 727. Remove reference to draft and lisp commands in man page 2012-10-26 09:59:20 -07:00
Craig Earls
3dc538189e Formatting cleanup 2012-10-23 12:04:07 -07:00
Craig Earls
6b5fb0da73 Reformatted tables and moved date formatting code section 2012-10-19 04:00:13 +02:00
Craig Earls
c51ad98a66 Fixe emacs command chapter heading 2012-10-13 08:16:39 -07:00
Craig Earls
0d90de44b6 Added more details to the convert command as provide by Johan Klahn 2012-10-13 07:48:00 -07:00
Craig Earls
f1c459b80c Fixed several typos and cleaned up formatting 2012-10-12 06:56:21 -07:00
Craig Earls
8c7ac50fd8 formatting and grammar cleanup 2012-10-10 21:21:00 -07:00
Craig Earls
d7a03c4716 Detailed section on the new commodity valuation system. 2012-10-10 09:43:16 -07:00
Craig Earls
25f063ab7c Fixes bug 801. Replaces "jorunal" with Ledger on line 235 of ledger3.texi 2012-10-10 07:31:17 -07:00
Craig Earls
8bb5bae7a9 Filled in many blank entries
Also reformatted the option lists to be more like the GCC manual
2012-10-09 16:09:09 -07:00
Craig Earls
ecc91c6b95 Corrected a few missing @ symbols per Jeroen 2012-10-04 06:25:18 -07:00
Craig Earls
1ebc014f55 correcte --period-sort arguments in section 7.3.1 2012-10-03 12:23:21 -07:00
Bradley M. Kuhn
06356ebf90 Make reference and link to Bug Report #789 in fixed directive documentation.
Due to weirdness that's currently true with the existing next branch of
ledger, I believe it's important to tell users in the documentation that
there are some discrepancies in the 'fixed' directive behavior.

The documentation from my previous commit is written to explain what
'fixed' *should* do; adding the bug report link here is a placeholder to
tell users that it may not do what they think it does.

Obviously, if someone closes #789, they should remove this paragraph added
herein.  But, if the bug report is closed, but the documentation lags
behind, the worst that happens is some users have to click through to see
the bug is closed.
2012-09-14 16:54:12 -04:00
Bradley M. Kuhn
438806ac71 Documentation for the fixed directive.
Based on conversation with johnw on IRC, I believe this text properly
documents the intended feature of the fixed directive.
2012-09-14 16:39:41 -04:00
Bradley M. Kuhn
ccf10e2060 Created Fixated prices node.
There was a Fixated prices section, but no Fixated prices node.
This of course required an update of nodes and menus throughout chapter.
2012-09-14 16:35:46 -04:00
Bradley M. Kuhn
137183d19f Fixed typo: removed extra @tab. 2012-09-10 00:12:51 -04:00
Bradley M. Kuhn
fa89dc16a6 Document "Data File Parsing Information" format strings.
Based on my reading of src/format.cc and inspection of output on some test
data, I believe this is adequate documentation for these format strings.
2012-09-10 00:08:59 -04:00
John Wiegley
a54ee9047b Doc fix 2012-08-07 15:19:59 -05:00
John Wiegley
f34a4e315e Change occurences of #+srcname to #+name 2012-08-01 16:08:43 -05:00
John Wiegley
cbf4cba18b Fixed a minor documentation bug 2012-06-25 19:10:45 -05:00
John Wiegley
4681e58d7f Converted the Ledger build system to use CMake 2012-05-20 04:48:05 -05:00
Craig Earls
aece63395b Commented out references to GNUCash 2012-04-04 06:09:50 -07:00
Martin Michlmayr
f4e6d30736 Document more commands in the man page 2012-03-25 15:25:39 +01:00
Martin Michlmayr
8e6a3ce0d0 Update manual to say that pricesdb option has been renamed to pricedb 2012-03-23 08:51:21 +00:00
Martin Michlmayr
2f7b7762c2 Update example to use new apply account directive
Update the example in the manual to use the new apply account/end apply
directive, as announced be John here:
http://groups.google.com/group/ledger-cli/tree/browse_frm/month/2012-02/977e5dd90a55efca
2012-03-22 22:55:54 +00:00
Craig Earls
4f21cd2700 Reorganized command directives 2012-03-18 16:27:48 -07:00
Craig Earls
4cbe042894 Merge pull request #60 from munkee/next
Fix an example of fixed lot prices
2012-03-18 09:04:09 -07:00
David Whitmarsh
db204e0907 Fix an example of fixed lot prices
Changed the results of the last example in 5.5.3 to match what really
happens
2012-03-18 09:42:43 -05:00
John Wiegley
db1bca2ad8 Merge branch 'next' of github.com:jwiegley/ledger into next 2012-03-18 02:34:25 -05:00
John Wiegley
f9088f8836 Added --verify-memory and missing TRACE_[CD]TOR calls 2012-03-18 01:01:30 -05:00