Skip to content

Commit

Permalink
improve the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sdementen committed Feb 2, 2018
1 parent 0b5277f commit 566c9ea
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
12 changes: 7 additions & 5 deletions docs/source/doc/doc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -168,18 +168,20 @@ or to create a new expense account for utilities:
Most basic objects used for personal finance are supported (Account, Split, Transaction, Price, ...).

Ready to use scripts
====================
The piecash command line interface
==================================

The `piecash` script offers the following features:
The `piecash` CLI offers the following features:

.. command-output:: piecash -h

To export data out of a GnuCash book:
To export specific entities out of a GnuCash book:

.. command-output:: piecash export -h

You can also run the `piecash` script on a gnucash file that is opened by GnuCash at the same time.
To export a GnuCash book to the ledger-cli format:

.. command-output:: piecash ledger -h

For more information on how to use piecash, please refer to the Tutorials on
:doc:`Using existing objects <../tutorial/index_existing>` and
Expand Down
7 changes: 4 additions & 3 deletions docs/source/tutorial/examples.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
Examples of scripts
===================
Examples of programs written with piecash
=========================================

You can find examples for scripts (loosely based on the scripts for the official python bindings for gnucash or on
You can find examples of programs/scripts (loosely based on the scripts for the
official python bindings for gnucash or on
questions posted on the mailing list) in the examples subfolder.

Creating and opening gnucash files
Expand Down

0 comments on commit 566c9ea

Please sign in to comment.