Skip to content

Commit

Permalink
Re-generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
blais committed Jul 23, 2024
1 parent 3baa7ab commit 360e326
Show file tree
Hide file tree
Showing 22 changed files with 43 additions and 240 deletions.
4 changes: 2 additions & 2 deletions docs/beancount_design_doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -624,7 +624,7 @@ The stream of directives comes with a few guarantees you can rest upon:

The process of **loading** a list of entries from an input file is the heart of the project. It is important to understand it in order to understand how Beancount works. Refer to the diagram below.

<img src="beancount_design_doc/media/4117596158f0642dae7becf17be7a89f169bf4a0.png" style="width:8.66667in;height:3.23611in" />
<img src="beancount_design_doc/media/6bbbdc0339d6207eab9d578bc1fc954db96ed97d.png" style="width:8.66667in;height:3.23611in" />

It consists of

Expand Down Expand Up @@ -698,7 +698,7 @@ So the parser will need to be split into two phases:

2. A separate step for the interpolation which will have available the inventory balances of each account as inputs. This second step is where the booking algorithms (e.g., FIFO) will be invoked from.

<img src="beancount_design_doc/media/033922268f9fe3d624c80b311804a81e4990ae07.png" style="width:6.05556in;height:3.01389in" />
<img src="beancount_design_doc/media/973adf6a5ea98d821f74996315976389bb1683dd.png" style="width:6.05556in;height:3.01389in" />

See the diagram above for reference. Once implemented, everything else should be the same.

Expand Down
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/calculating_portolio_returns.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Using the cash flows, I will then run a **simple root finding routine to calcula

Here's a diagram that shows how the "configure", "compute\_returns" and "download\_prices" scripts work together:

<img src="calculating_portolio_returns/media/5a7ab6a50f230c54b1821653b48792a8a1e3a451.png" style="width:7.18056in;height:7.09722in" />
<img src="calculating_portolio_returns/media/4f4d457bc907c750277ca40745ed1686f7d9017a.png" style="width:7.18056in;height:7.09722in" />

These will be further detailed below.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
2 changes: 2 additions & 0 deletions docs/external_contributions.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,8 @@ The Beancount v3 parser uses [<u>RE/flex</u>](https://www.genivia.com/doc/reflex

[<u>rlan/beancount-multitool</u>](https://github.com/rlan/beancount-multitool) (Rick Lan): Beancount Multitool is a command-line-interface (CLI) tool that converts financial data from financial institutions to Beancount files (supported: JA Bank JAネットバンク, Rakuten Card 楽天カード, Rakuten Bank 楽天銀行, SBI Shinsei Bank 新生銀行). Associated post: [<u>https://www.linkedin.com/feed/update/urn:li:activity:7198125470662500352/</u>](https://www.linkedin.com/feed/update/urn:li:activity:7198125470662500352/)

[<u>LaunchPlatform/beanhub-import</u>](https://github.com/LaunchPlatform/beanhub-import) (Fang-Pen Lin): Beanhub-import is a simple, declarative, smart, and easy-to-use library for importing extracted transactions from beanhub-extract. It generates Beancount transactions based on predefined rules.

## Converters<a id="converters"></a>

[<u>plaid2text</u>](https://github.com/madhat2r/plaid2text): Python Scripts to export Plaid transactions and transform them into Ledger or Beancount syntax formatted files.
Expand Down
2 changes: 1 addition & 1 deletion docs/how_we_share_expenses.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ After that, going back to the Kyle ledger, pulling in all the transactions again

Here’s a diagram that puts in perspective the entire system together:

<img src="how_we_share_expenses/media/beea06bbfc314c84ad8172b5b42f72fdb5ee8d67.png" style="width:8.79167in;height:6.94444in" />
<img src="how_we_share_expenses/media/859a53a2976ca14d122483a7f69e419afe2609c0.png" style="width:8.79167in;height:6.94444in" />

I (“Dad”) use Beancount via Emacs, exclusively. Carolyn (“Mom”) only interacts with a single Google Sheets doc with three sheets in it. I pull in Carolyn’s shared expenses from a sheet that she fills in to a ledger which gets included in my personal ledger. I also pull in her expenses for Kyle in a similar document, and from my personal ledger I generate my own expenses for Kyle. Both of these documents are merged in a top-level ledger dedicated to Kyle’s expenses.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
264 changes: 33 additions & 231 deletions docs/installing_beancount.md

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/sharing_expenses_with_beancount.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,19 +40,19 @@ One of the attributes of the method we show here is that the decision of how we

In this section we present a brief illustrated overview of the method. A set of common Assets accounts that belong to the project, and book all our individual expenses and transfer for the trip as coming from external Income accounts:

<img src="sharing_expenses_with_beancount/media/905d3349c7af8500347aa0e5af656e943abe2591.png" style="width:3.94444in;height:2.08333in" />
<img src="sharing_expenses_with_beancount/media/e9418073c42793ed5a2bdbc69f415ad2d0a1ff08.png" style="width:3.94444in;height:2.08333in" />

During the trip, we use the common Assets to make expenses. Most of the expenses are attributed to both of us (and to be shared eventually), but some of the expenses are intended to be attributed to each of us individually:

<img src="sharing_expenses_with_beancount/media/6497688e752bd90be8d7257afa678cc1fd1d8084.png" style="width:3.94444in;height:2.23611in" />
<img src="sharing_expenses_with_beancount/media/132c6d11d6e252da29b6947bcd9d65f56d08370e.png" style="width:3.94444in;height:2.23611in" />

After the trip, remaining Assets (like cash we walked home with) gets distributed back to ourselves to zero out the balances of the Assets accounts and we record this through contra postings to Income accounts:

<img src="sharing_expenses_with_beancount/media/e897ff1fb4ea70efa1164dca215811e00b4a06d0.png" style="width:3.90278in;height:2.94444in" />
<img src="sharing_expenses_with_beancount/media/98f0e5ed8b0be4c152e147c3f41ee833bb11cc5c.png" style="width:3.90278in;height:2.94444in" />

Finally, the list of shared Expenses are split between each other—using a plugin that forks every posting that is intended to be a shared expense—and the final amount is used to make a final transfer between each other so that we’ve each paid for our respective expenses and we’re square:

<img src="sharing_expenses_with_beancount/media/1c45addecaf77f45c6cc5867529bfaed232e45f1.png" style="width:4.86111in;height:1.97222in" />
<img src="sharing_expenses_with_beancount/media/51e501649abf9acccf147ac47836b82a2d07b8f9.png" style="width:4.86111in;height:1.97222in" />

Note that the final balance of expenses for each participant may differ, and these are due to particular expenses that were attributed separately, or if we decide to split the total unevenly.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
beancount==2.3.0
beautifulsoup4==4.9.0
mkdocs==1.2.4
mkdocs-redirects==1.0.3
Expand Down

0 comments on commit 360e326

Please sign in to comment.