Skip to content

Commit

Permalink
Deployed be7719d with MkDocs version: 1.2.4
Browse files Browse the repository at this point in the history
  • Loading branch information
@xuhcc
xuhcc committed May 1, 2024
1 parent 44a5327 commit 819d9b1
Show file tree
Hide file tree
Showing 21 changed files with 96 additions and 560 deletions.
10 changes: 5 additions & 5 deletions api_reference/beancount.core.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3233,7 +3233,7 @@ <h4 id="beancount.core.amount.Amount.from_string" class="doc doc-heading">


<h4 id="beancount.core.amount.Amount.to_string" class="doc doc-heading">
<code class="highlight language-python">beancount.core.amount.Amount.to_string(self, dformat=&lt;beancount.core.display_context.DisplayFormatter object at 0x7d36c89b5650&gt;)</code>
<code class="highlight language-python">beancount.core.amount.Amount.to_string(self, dformat=&lt;beancount.core.display_context.DisplayFormatter object at 0x7231ebef5670&gt;)</code>


<a href="#beancount.core.amount.Amount.to_string" class="headerlink" title="Permanent link"></a></h4>
Expand Down Expand Up @@ -7630,7 +7630,7 @@ <h3 id="beancount.core.data.new_directive" class="doc doc-heading">
<th class="field-name">Returns:</th>
<td class="field-body">
<ul class="first simple">
<li><p><code>&lt;function NamedTuple at 0x7d36c8d12de0&gt;</code> – A type object for the new directive type.</p></li>
<li><p><code>&lt;function NamedTuple at 0x7231ec2fb240&gt;</code> – A type object for the new directive type.</p></li>
</ul>
</td>
</tr>
Expand Down Expand Up @@ -14017,7 +14017,7 @@ <h4 id="beancount.core.inventory.Inventory.segregate_units" class="doc doc-headi


<h4 id="beancount.core.inventory.Inventory.to_string" class="doc doc-heading">
<code class="highlight language-python">beancount.core.inventory.Inventory.to_string(self, dformat=&lt;beancount.core.display_context.DisplayFormatter object at 0x7d36c89b5650&gt;, parens=True)</code>
<code class="highlight language-python">beancount.core.inventory.Inventory.to_string(self, dformat=&lt;beancount.core.display_context.DisplayFormatter object at 0x7231ebef5670&gt;, parens=True)</code>


<a href="#beancount.core.inventory.Inventory.to_string" class="headerlink" title="Permanent link"></a></h4>
Expand Down Expand Up @@ -15855,7 +15855,7 @@ <h4 id="beancount.core.position.Position.sortkey" class="doc doc-heading">


<h4 id="beancount.core.position.Position.to_string" class="doc doc-heading">
<code class="highlight language-python">beancount.core.position.Position.to_string(self, dformat=&lt;beancount.core.display_context.DisplayFormatter object at 0x7d36c89b5650&gt;, detail=True)</code>
<code class="highlight language-python">beancount.core.position.Position.to_string(self, dformat=&lt;beancount.core.display_context.DisplayFormatter object at 0x7231ebef5670&gt;, detail=True)</code>


<a href="#beancount.core.position.Position.to_string" class="headerlink" title="Permanent link"></a></h4>
Expand Down Expand Up @@ -16262,7 +16262,7 @@ <h3 id="beancount.core.position.get_position" class="doc doc-heading">


<h3 id="beancount.core.position.to_string" class="doc doc-heading">
<code class="highlight language-python">beancount.core.position.to_string(pos, dformat=&lt;beancount.core.display_context.DisplayFormatter object at 0x7d36c89b5650&gt;, detail=True)</code>
<code class="highlight language-python">beancount.core.position.to_string(pos, dformat=&lt;beancount.core.display_context.DisplayFormatter object at 0x7231ebef5670&gt;, detail=True)</code>


<a href="#beancount.core.position.to_string" class="headerlink" title="Permanent link"></a></h3>
Expand Down
8 changes: 4 additions & 4 deletions api_reference/beancount.parser.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3793,7 +3793,7 @@ <h3 id="beancount.parser.cmptest.TestError" class="doc doc-heading">


<h3 id="beancount.parser.cmptest.assertEqualEntries" class="doc doc-heading">
<code class="highlight language-python">beancount.parser.cmptest.assertEqualEntries(expected_entries, actual_entries, failfunc=&lt;function fail at 0x7d36c7f723e0&gt;, allow_incomplete=False)</code>
<code class="highlight language-python">beancount.parser.cmptest.assertEqualEntries(expected_entries, actual_entries, failfunc=&lt;function fail at 0x7231eb6c4e00&gt;, allow_incomplete=False)</code>


<a href="#beancount.parser.cmptest.assertEqualEntries" class="headerlink" title="Permanent link"></a></h3>
Expand Down Expand Up @@ -3894,7 +3894,7 @@ <h3 id="beancount.parser.cmptest.assertEqualEntries" class="doc doc-heading">


<h3 id="beancount.parser.cmptest.assertExcludesEntries" class="doc doc-heading">
<code class="highlight language-python">beancount.parser.cmptest.assertExcludesEntries(subset_entries, entries, failfunc=&lt;function fail at 0x7d36c7f723e0&gt;, allow_incomplete=False)</code>
<code class="highlight language-python">beancount.parser.cmptest.assertExcludesEntries(subset_entries, entries, failfunc=&lt;function fail at 0x7231eb6c4e00&gt;, allow_incomplete=False)</code>


<a href="#beancount.parser.cmptest.assertExcludesEntries" class="headerlink" title="Permanent link"></a></h3>
Expand Down Expand Up @@ -3986,7 +3986,7 @@ <h3 id="beancount.parser.cmptest.assertExcludesEntries" class="doc doc-heading">


<h3 id="beancount.parser.cmptest.assertIncludesEntries" class="doc doc-heading">
<code class="highlight language-python">beancount.parser.cmptest.assertIncludesEntries(subset_entries, entries, failfunc=&lt;function fail at 0x7d36c7f723e0&gt;, allow_incomplete=False)</code>
<code class="highlight language-python">beancount.parser.cmptest.assertIncludesEntries(subset_entries, entries, failfunc=&lt;function fail at 0x7231eb6c4e00&gt;, allow_incomplete=False)</code>


<a href="#beancount.parser.cmptest.assertIncludesEntries" class="headerlink" title="Permanent link"></a></h3>
Expand Down Expand Up @@ -9670,7 +9670,7 @@ <h4 id="beancount.parser.options.OptGroup.__repr__" class="doc doc-heading">


<h3 id="beancount.parser.options.Opt" class="doc doc-heading">
<code class="highlight language-python">beancount.parser.options.Opt(name, default_value, example_value=&lt;object object at 0x7d36c8f85870&gt;, converter=None, deprecated=False, alias=None)</code>
<code class="highlight language-python">beancount.parser.options.Opt(name, default_value, example_value=&lt;object object at 0x7231ec579900&gt;, converter=None, deprecated=False, alias=None)</code>


<a href="#beancount.parser.options.Opt" class="headerlink" title="Permanent link"></a></h3>
Expand Down
2 changes: 1 addition & 1 deletion api_reference/beancount.tools.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -488,7 +488,7 @@ <h3 id="beancount.tools.treeify.create_tree" class="doc doc-heading">


<h3 id="beancount.tools.treeify.dump_tree" class="doc doc-heading">
<code class="highlight language-python">beancount.tools.treeify.dump_tree(node, file=&lt;_io.StringIO object at 0x7d36c5520ee0&gt;, prefix='')</code>
<code class="highlight language-python">beancount.tools.treeify.dump_tree(node, file=&lt;_io.StringIO object at 0x7231e85f7700&gt;, prefix='')</code>


<a href="#beancount.tools.treeify.dump_tree" class="headerlink" title="Permanent link"></a></h3>
Expand Down
2 changes: 1 addition & 1 deletion api_reference/beancount.utils.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4430,7 +4430,7 @@ <h3 id="beancount.utils.misc_utils.import_curses" class="doc doc-heading">


<h3 id="beancount.utils.misc_utils.is_sorted" class="doc doc-heading">
<code class="highlight language-python">beancount.utils.misc_utils.is_sorted(iterable, key=&lt;function &lt;lambda&gt; at 0x7d36c8a43d80&gt;, cmp=&lt;function &lt;lambda&gt; at 0x7d36c8a43e20&gt;)</code>
<code class="highlight language-python">beancount.utils.misc_utils.is_sorted(iterable, key=&lt;function &lt;lambda&gt; at 0x7231ebf718a0&gt;, cmp=&lt;function &lt;lambda&gt; at 0x7231ebf71940&gt;)</code>


<a href="#beancount.utils.misc_utils.is_sorted" class="headerlink" title="Permanent link"></a></h3>
Expand Down
110 changes: 8 additions & 102 deletions beancount_cheat_sheet.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -221,114 +221,20 @@
<div class="section">

<h1 id="beancount-syntax-cheat-sheet">Beancount Syntax Cheat Sheet<a id="title"></a><a class="headerlink" href="#beancount-syntax-cheat-sheet" title="Permanent link"></a></h1>
<table>
<colgroup>
<col style="width: 47%" />
<col style="width: 52%" />
</colgroup>
<thead>
<tr class="header">
<th><p><em>Example Account Name:</em> Assets:US:BofA:Checking</p>
<table>
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr class="header">
<th><h2 id="account-types">Account Types<a id="account-types"></a></h2>
<table>
<colgroup>
<col style="width: 60%" />
<col style="width: 39%" />
</colgroup>
<thead>
<tr class="header">
<th><p>Assets</p>
<p>Liabilities</p>
<p>Income</p>
<p>Expenses</p>
<p>Equity</p></th>
<th><p><strong>+</strong></p>
<p><strong>-</strong></p>
<p><strong>-</strong></p>
<p><strong>+</strong></p>
<p><strong>-</strong></p></th>
</tr>
</thead>
<tbody>
</tbody>
</table></th>
<th><h2 id="commodities">Commodities<a id="commodities"></a></h2>
<p><em>All in CAPS:</em></p>
<p>USD, EUR, CAD, AUD</p>
<p>GOOG, AAPL, RBF1005</p>
<p>HOME_MAYST, AIRMILES<br />
HOURS</p></th>
</tr>
</thead>
<tbody>
</tbody>
</table>
<h2 id="directives">Directives<a id="directives"></a></h2>
<blockquote>
<p><em>General syntax:</em></p>
<p><strong>YYYY-MM-DD <em>&lt;directive&gt; &lt;arguments...&gt;</em></strong></p>
</blockquote>
<h2 id="opening-closing-accounts">Opening &amp; Closing Accounts<a id="opening-closing-accounts"></a></h2>
<p>2001-05-29 open Expenses:Restaurant</p>
<p>2001-05-29 open Assets:Checking USD,EUR <em>; Currency constraints</em></p>
<p>2015-04-23 close Assets:Checking</p>
<h2 id="declaring-commodities">Declaring Commodities<a id="declaring-commodities"></a></h2>
<p><em>This is optional; use this only if you want to attach metadata by currency.</em></p>
<p>1998-07-22 commodity AAPL<br />
name: "Apple Computer Inc."</p>
<h2 id="prices">Prices<a id="prices"></a></h2>
<p><em>Use many times to fill historical price database:</em></p>
<p>2015-04-30 price AAPL 125.15 USD</p>
<p>2015-05-30 price AAPL 130.28 USD</p>
<h2 id="notes">Notes<a id="notes"></a></h2>
<p>2013-03-20 note Assets:Checking "Called to ask about rebate"</p>
<h2 id="documents">Documents<a id="documents"></a></h2>
<p>2013-03-20 document Assets:Checking "path/to/statement.pdf"</p></th>
<th><h2 id="transactions">Transactions<a id="transactions"></a></h2>
<p>2015-05-30 * "Some narration about this transaction"<br />
<table><tbody><tr class="odd"><td><p><em>Example Account Name:</em> Assets:US:BofA:Checking</p><table><tbody><tr class="odd"><td><h2 id="account-types">Account Types<a id="account-types"></a></h2><table><tbody><tr class="odd"><td><p>Assets</p><p>Liabilities</p><p>Income</p><p>Expenses</p><p>Equity</p></td><td><p><strong>+</strong></p><p><strong>-</strong></p><p><strong>-</strong></p><p><strong>+</strong></p><p><strong>-</strong></p></td></tr></tbody></table></td><td><h2 id="commodities">Commodities<a id="commodities"></a></h2><p><em>All in CAPS:</em></p><p>USD, EUR, CAD, AUD</p><p>GOOG, AAPL, RBF1005</p><p>HOME_MAYST, AIRMILES<br />
HOURS</p></td></tr></tbody></table><h2 id="directives">Directives<a id="directives"></a></h2><blockquote><p><em>General syntax:</em></p><p><strong>YYYY-MM-DD <em>&lt;directive&gt; &lt;arguments...&gt;</em></strong></p></blockquote><h2 id="opening-closing-accounts">Opening &amp; Closing Accounts<a id="opening-closing-accounts"></a></h2><p>2001-05-29 open Expenses:Restaurant</p><p>2001-05-29 open Assets:Checking USD,EUR <em>; Currency constraints</em></p><p>2015-04-23 close Assets:Checking</p><h2 id="declaring-commodities">Declaring Commodities<a id="declaring-commodities"></a></h2><p><em>This is optional; use this only if you want to attach metadata by currency.</em></p><p>1998-07-22 commodity AAPL<br />
name: "Apple Computer Inc."</p><h2 id="prices">Prices<a id="prices"></a></h2><p><em>Use many times to fill historical price database:</em></p><p>2015-04-30 price AAPL 125.15 USD</p><p>2015-05-30 price AAPL 130.28 USD</p><h2 id="notes">Notes<a id="notes"></a></h2><p>2013-03-20 note Assets:Checking "Called to ask about rebate"</p><h2 id="documents">Documents<a id="documents"></a></h2><p>2013-03-20 document Assets:Checking "path/to/statement.pdf"</p></td><td><h2 id="transactions">Transactions<a id="transactions"></a></h2><p>2015-05-30 * "Some narration about this transaction"<br />
Liabilities:CreditCard -101.23 USD<br />
Expenses:Restaurant 101.23 USD</p>
<p>2015-05-30 ! "Cable Co" "Phone Bill" #tag ˆlink</p>
<p>id: "TW378743437" <em>; Meta-data</em><br />
Expenses:Restaurant 101.23 USD</p><p>2015-05-30 ! "Cable Co" "Phone Bill" #tag ˆlink</p><p>id: "TW378743437" <em>; Meta-data</em><br />
Expenses:Home:Phone 87.45 USD<br />
Assets:Checking <em>; You may leave one amount out</em></p>
<h3 id="postings">Postings<a id="postings"></a></h3>
<p>... 123.45 USD <em>Simple</em><br />
Assets:Checking <em>; You may leave one amount out</em></p><h3 id="postings">Postings<a id="postings"></a></h3><p>... 123.45 USD <em>Simple</em><br />
... 10 GOOG <strong>{502.12 USD}</strong> <em>With per-unit cost<br />
</em> ... 10 GOOG <strong>{{5021.20 USD}}</strong> <em>With total cost</em></p>
<p>... 10 GOOG <strong>{502.12 # 9.95 USD}</strong> <em>With both costs</em><br />
</em> ... 10 GOOG <strong>{{5021.20 USD}}</strong> <em>With total cost</em></p><p>... 10 GOOG <strong>{502.12 # 9.95 USD}</strong> <em>With both costs</em><br />
... 1000.00 USD <strong>@ 1.10 CAD</strong> <em>With per-unit price</em><br />
... 10 GOOG {502.12 USD} @ 1.10 CAD <em>With cost &amp; price</em><br />
... 10 GOOG {502.12 USD, <strong>2014-05-12</strong>} <em>With date</em><br />
<strong>!</strong> ... 123.45 USD ... <em>With flag</em></p>
<h2 id="balance-assertions-and-padding">Balance Assertions and Padding<a id="balance-assertions-and-padding"></a></h2>
<p><em>Asserts the amount for only the given currency:</em></p>
<p>2015-06-01 balance Liabilities:CreditCard -634.30 USD</p>
<p><em>Automatic insertion of transaction to fulfill the following assertion:</em></p>
<p>YYYY-MM-DD pad Assets:Checking Equity:Opening-Balances</p>
<h2 id="events">Events<a id="events"></a></h2>
<p>YYYY-MM-DD event "location" "New York, USA"<br />
YYYY-MM-DD event "address" "123 May Street"</p>
<h2 id="options">Options <a id="options"></a></h2>
<p>option "title" "My Personal Ledger"</p>
<p><em>See <a href="beancount_options_reference.md"><u>this doc</u></a> for the full list of supported options.</em></p>
<h2 id="other">Other<a id="other"></a></h2>
<p>pushtag #trip-to-peru</p>
<p>...</p>
<p>poptag #trip-to-peru</p>
<p>; Comments begin with a semi-colon</p></th>
</tr>
</thead>
<tbody>
</tbody>
</table>
<strong>!</strong> ... 123.45 USD ... <em>With flag</em></p><h2 id="balance-assertions-and-padding">Balance Assertions and Padding<a id="balance-assertions-and-padding"></a></h2><p><em>Asserts the amount for only the given currency:</em></p><p>2015-06-01 balance Liabilities:CreditCard -634.30 USD</p><p><em>Automatic insertion of transaction to fulfill the following assertion:</em></p><p>YYYY-MM-DD pad Assets:Checking Equity:Opening-Balances</p><h2 id="events">Events<a id="events"></a></h2><p>YYYY-MM-DD event "location" "New York, USA"<br />
YYYY-MM-DD event "address" "123 May Street"</p><h2 id="options">Options <a id="options"></a></h2><p>option "title" "My Personal Ledger"</p><p><em>See <a href="beancount_options_reference.md"><u>this doc</u></a> for the full list of supported options.</em></p><h2 id="other">Other<a id="other"></a></h2><p>pushtag #trip-to-peru</p><p>...</p><p>poptag #trip-to-peru</p><p>; Comments begin with a semi-colon</p></td></tr></tbody></table>

</div>
</div>
Expand Down
Loading

0 comments on commit 819d9b1

Please sign in to comment.