Skip to content

Commit

Permalink
Fix documentation error
Browse files Browse the repository at this point in the history
  • Loading branch information
JerBouma committed Apr 29, 2024
1 parent ac627b8 commit 9061054
Show file tree
Hide file tree
Showing 12 changed files with 738 additions and 15 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -486,7 +486,7 @@ jobs:
"""
create_markdown_file(
file_url="https://github.com/JerBouma/FinanceToolkit/blob/main/financetoolkit/fixedincome/fixedincome_controller.py",
file_url="https://api.github.com/repos/JerBouma/FinanceToolkit/contents/financetoolkit/fixedincome/fixedincome_controller.py",
header=markdown_content,
location="_pages/financetoolkit/documentation/fixedincome.md",
)
Expand Down
7 changes: 4 additions & 3 deletions _pages/financetoolkit/documentation/discovery.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Discovery
excerpt: The Discovery Module contains lists of companies, cryptocurrencies, forex, commodities, etfs and indices including screeners, quotes, performance metrics and more to find and select tickers to use in the Finance Toolkit.
description: The Discovery Module contains lists of companies, cryptocurrencies, forex, commodities, etfs and indices including screeners, quotes, performance metrics and more to find and select tickers to use in the Finance Toolkit.
excerpt: The Discovery Module contains lists of companies, cryptocurrencies, forex, commodities, etfs and indices including screeners, quotes, performance metrics and more to find and select tickers to use in the Finance Toolkit.
description: The Discovery Module contains lists of companies, cryptocurrencies, forex, commodities, etfs and indices including screeners, quotes, performance metrics and more to find and select tickers to use in the Finance Toolkit.
author_profile: false
permalink: /projects/financetoolkit/docs/discovery
classes: wide-sidebar
Expand All @@ -21,7 +21,7 @@ To install the FinanceToolkit it simply requires the following:
pip install financetoolkit -U
{% endhighlight %}

If you are looking for documentation regarding the toolkit, ratios, models, technicals, risk, performance and economics, please have a look below:
If you are looking for documentation regarding the toolkit, ratios, models, technicals, fixed income, risk, performance and economics, please have a look below:

<div style="display: flex; justify-content: space-between;" class="show-on-desktop">
<a href="/projects/financetoolkit/docs" class="btn btn--info" style="flex: 1;margin-right:5px">Toolkit</a>
Expand All @@ -30,6 +30,7 @@ If you are looking for documentation regarding the toolkit, ratios, models, tech
<a href="/projects/financetoolkit/docs/models" class="btn btn--info" style="flex: 1;margin-right:5px">Models</a>
<a href="/projects/financetoolkit/docs/options" class="btn btn--info" style="flex: 1;margin-right:5px">Options</a>
<a href="/projects/financetoolkit/docs/technicals" class="btn btn--info" style="flex: 1;margin-right:5px">Technicals</a>
<a href="/projects/financetoolkit/docs/fixedincome" class="btn btn--info" style="flex: 1;margin-right:5px">Fixed Income</a>
<a href="/projects/financetoolkit/docs/risk" class="btn btn--info" style="flex: 1;margin-right:5px">Risk</a>
<a href="/projects/financetoolkit/docs/performance" class="btn btn--info" style="flex: 1;margin-right:5px">Performance</a>
<a href="/projects/financetoolkit/docs/economics" class="btn btn--info" style="flex: 1; ">Economics</a>
Expand Down
3 changes: 2 additions & 1 deletion _pages/financetoolkit/documentation/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ pip install financetoolkit -U

The Toolkit Module is meant to be a collection of useful functions that collect and parse data. These are historical data, fundamental data (balance, income and cash flow statements) as well as several others metrics from Financial Modeling Prep like enterprise values, company profiles and more. From this module, you are able to access the related modules as well.

If you are looking for documentation regarding the discovery, ratios, models, technical indicators, risk metrics, performance metrics and economic indicators, please have a look below:
If you are looking for documentation regarding the discovery, ratios, models, technical indicators, fixed income, risk metrics, performance metrics and economic indicators, please have a look below:

<div style="display: flex; justify-content: space-between;" class="show-on-desktop">
<a href="/projects/financetoolkit/docs" class="btn btn--warning" style="flex: 1;margin-right:5px">Toolkit</a>
Expand All @@ -32,6 +32,7 @@ If you are looking for documentation regarding the discovery, ratios, models, te
<a href="/projects/financetoolkit/docs/models" class="btn btn--info" style="flex: 1;margin-right:5px">Models</a>
<a href="/projects/financetoolkit/docs/options" class="btn btn--info" style="flex: 1;margin-right:5px">Options</a>
<a href="/projects/financetoolkit/docs/technicals" class="btn btn--info" style="flex: 1;margin-right:5px">Technicals</a>
<a href="/projects/financetoolkit/docs/fixedincome" class="btn btn--info" style="flex: 1;margin-right:5px">Fixed Income</a>
<a href="/projects/financetoolkit/docs/risk" class="btn btn--info" style="flex: 1;margin-right:5px">Risk</a>
<a href="/projects/financetoolkit/docs/performance" class="btn btn--info" style="flex: 1;margin-right:5px">Performance</a>
<a href="/projects/financetoolkit/docs/economics" class="btn btn--info" style="flex: 1; ">Economics</a>
Expand Down
3 changes: 2 additions & 1 deletion _pages/financetoolkit/documentation/economics.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ To install the FinanceToolkit it simply requires the following:
pip install financetoolkit -U
{% endhighlight %}

If you are looking for documentation regarding the toolkit, discovery, ratios, models, technicals, risk and performance, please have a look below:
If you are looking for documentation regarding the toolkit, discovery, ratios, models, technicals, fixed income, risk and performance, please have a look below:

<div style="display: flex; justify-content: space-between;" class="show-on-desktop">
<a href="/projects/financetoolkit/docs" class="btn btn--info" style="flex: 1;margin-right:5px">Toolkit</a>
Expand All @@ -30,6 +30,7 @@ If you are looking for documentation regarding the toolkit, discovery, ratios, m
<a href="/projects/financetoolkit/docs/models" class="btn btn--info" style="flex: 1;margin-right:5px">Models</a>
<a href="/projects/financetoolkit/docs/options" class="btn btn--info" style="flex: 1;margin-right:5px">Options</a>
<a href="/projects/financetoolkit/docs/technicals" class="btn btn--info" style="flex: 1;margin-right:5px">Technicals</a>
<a href="/projects/financetoolkit/docs/fixedincome" class="btn btn--info" style="flex: 1;margin-right:5px">Fixed Income</a>
<a href="/projects/financetoolkit/docs/risk" class="btn btn--info" style="flex: 1;margin-right:5px">Risk</a>
<a href="/projects/financetoolkit/docs/performance" class="btn btn--info" style="flex: 1;margin-right:5px">Performance</a>
<a href="/projects/financetoolkit/docs/economics" class="btn btn--warning" style="flex: 1; ">Economics</a>
Expand Down
Loading

0 comments on commit 9061054

Please sign in to comment.