Commit Graph

126 Commits

Author SHA1 Message Date
andrewkenreich
e042116fab Docs part 2 (#3625)
* changes

* fixes 2

* po fixes

* 60-40

* few more fixes on links

* Update docker location

* Fix from basics

* Sorry Andrew

* putting /build in docker

Co-authored-by: James Maslek <jmaslek11@gmail.com>
Co-authored-by: Jeroen Bouma <jeroenbouma@Jeroens-MacBook-Pro.local>
2022-11-28 17:19:18 -05:00
andrewkenreich
6381b2ae7d Doc updates and fixes (#3609)
* fixing a url

* moving around menus

* Grammar Update

* many fixes to links and some added pics to install

* Add improvements

* fix: tabs

* Move support/feedback window to FAQ

* Forgot to save

* MVC moved around

* change installation Source -> Python

* fix: tabs

* guides to basics

* Add new README LINKS

* Change links

* Change forecasting to forecast

* fix: details

* more fixes

* Change markdown file so it is ready for pypi

Co-authored-by: Chavithra <chavithra@gmail.com>
Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com>
Co-authored-by: Jeroen Bouma <jeroenbouma@Jeroens-MacBook-Pro.local>
Co-authored-by: jose-donato <zmcdonato@gmail.com>
2022-11-28 12:13:47 -05:00
Danglewood
24d19030ed Updates SDK Portfolio Guide (#3592)
* Updates SDK Portfolio Guide

* Updates with requested changes.

I think that's all of them.

* URL update

* Table rounded to 2 decimals.

* rest of the tables rounding

Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com>
2022-11-28 12:17:32 +01:00
Danglewood
536ed9f7a0 Creates Dark Pools and Short Data SDK Guide (#3611)
* Creates Dark Pools and Short Data SDK Guide

* Linter

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
2022-11-28 08:53:03 +01:00
Danglewood
4e0f510b91 updated TA SDK guide import block with comment (more copy/paste friendly) (#3595) 2022-11-27 15:01:09 -05:00
Danglewood
fda3b786b4 Adds Stocks/DD SDK Intro Guide (#3598) 2022-11-27 15:00:39 -05:00
teh_coderer
79046608b6 Docs Fix (#3543)
* Update generate_terminal_markdown.py

* updates

* update workflows

* Automated Change

* tests

* tests

* Automated Change

* Update test_generate_docs.py

* Automated Change

* updates

* Automated Change

* Update gen-docs.yml

* Update test.yml

* Automated Change

* Update test.yml

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* test

* Automated Change

* testtt23

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* Automated Change

* added empting reference folders before autogen docs

* updates

* Automated Change

* update tests gitactions

* Automated Change

* up

* Automated Change

* Automated Change

* update pytest

* Automated Change

* tests

* Automated Change

* examples update

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* Update test.yml

* Update generate_sdk_markdown.py

* strip

* Automated Change

* Workflow : check test update

* Automated Change

* Automated Change

* Automated Change

* Update test.yml

* Automated Change

* Update test.yml

* Automated Change

* Automated Change

* up

* Automated Change

* Update generate_sdk_markdown.py

* Automated Change

* update workflows

* fix guides

* testing

* Update gh-pages.yml

* Update gh-pages.yml

Co-authored-by: tehcoderer <tehcoderer@users.noreply.github.com>
Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com>
Co-authored-by: Chavithra PARANA <chavithra@gmail.com>
Co-authored-by: Chavithra <Chavithra@users.noreply.github.com>
Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
Co-authored-by: jose-donato <jose-donato@users.noreply.github.com>
2022-11-25 17:19:08 -05:00
jose-donato
55b1facd1f FIx anchor tags in documentation (#3583)
* feat: fixes on docs website

* fix: fix anchor tags
2022-11-25 17:14:26 -05:00
martinb-bb
e1bba247e2 Forecast docstring fixes and other things (#3564)
* init commit for doc string fixes

* quick fix

* Forecast Guide Draft 1

* grammar

* sentence edit

* missing word

* target column is a string, not a list. ooops

* clarification on default target column

* minor mods

* more fixes

* Fixed dashboard

* val instead of tickerseries

* Added fixes

* $ --> <>

* Fixed pylint

* one quick change

Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
Co-authored-by: Colin Delahunty <72827203+colin99d@users.noreply.github.com>
Co-authored-by: colin99d <colin99delahunty@gmail.com>
2022-11-25 17:13:38 -05:00
montezdesousa
598044ac6a Fix [Bug] SDK - openbb.stocks.dps.vol_exch_chart - Error: 'Date' (#3561)
* remove volexch

* remove volexch from sdk
2022-11-25 14:50:10 -05:00
Jeroen Bouma
6316d36be1 Many improvements to the documentation (#3562)
* Many improvements

* Forgot these

* Set menus correctly

* Delete unrelated code

* Add in chart styling

* Add in simple guide to chart styling

* More updates

* last changes

* Update changing-sources.md

* Update file to redirect to proper folder and formatting

Co-authored-by: Jeroen Bouma <jeroenbouma@Jeroens-MacBook-Pro.local>
Co-authored-by: Jeroen Bouma <jeroenbouma@jeroens-mbp.home>
2022-11-25 18:10:28 +00:00
jose-donato
dc9ae37f6a feat: fixes on docs website (#3563)
Co-authored-by: Colin Delahunty <72827203+colin99d@users.noreply.github.com>
2022-11-25 10:44:06 +00:00
martinb-bb
7c57fb71c5 Fixing Forecast SDK with data from other menus (#3554)
* minor check incase using sdk

* fixes combine

* datetime formating

* Update forecast.md

* fix testing
2022-11-24 11:59:10 -05:00
Danglewood
a4d62fe1ad Fixes some things, and adds an additional example (#3547)
Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com>
2022-11-24 12:50:15 +01:00
Danglewood
244eaa3d1e edits for pip install openbbterminal[extras] --> pip install openbb[extras] (#3548)
* edits for `pip install openbbterminal[extras]` --> pip install openbb[extras]

* another one

Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com>
2022-11-24 10:06:32 +01:00
Jeroen Bouma
95431ecb85 Many improvements to the documentation (#3542)
* Many improvements to the documentation

* Remove redundant guides

* details

* Add guide backin

* linting

* Update FAQs

* Match it up with SDK

* add po to sdk

* Add PO in

* adding discovery

* adding BA and FA to sdk

* Add in Troubleshooting page

* quick fix on forecast

* onemore quickie

* fix sdk

* updates to troubleshooting

* Add in ticker to codespel so it doesn't whine

Co-authored-by: Jeroen Bouma <jeroenbouma@Jeroens-MacBook-Pro.local>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: martinb-bb <105685594+martinb-bb@users.noreply.github.com>
Co-authored-by: james <jmaslek11@gmail.com>
2022-11-24 08:27:04 +01:00
Danglewood
e0a08aaf04 Adds missing commands to QA; moves it out of Stocks; to be like TA (#3540)
* Adds missing commands

* Moved out of Stocks to be like TA
2022-11-23 12:33:55 -05:00
James Maslek
649dd1d64b Fix linter issue (#3538)
* Fix linter issue

* Didnt import optimization menu

* Fix some things for deployment

* openbbterminal -> openbb

* openbb
2022-11-22 20:40:44 -05:00
andrewkenreich
a0c5b4946a add changes to docs (#3533)
* add changes

* fix

* change 2

* fix: new folder structure

* fix: jeroen stuff

* fix: grammer

Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
Co-authored-by: jose-donato <zmcdonato@gmail.com>
Co-authored-by: James Maslek <jmaslek11@gmail.com>
2022-11-22 17:42:44 -05:00
jose-donato
e1962252ad Docs fixes (#3530)
* fix(docs): added margin between sections

* fix: images

* readd old content for examples/images

* fix: codespell

* fix: codespell

* fix: ga

* fix: remove temp lorem ipsum

* fix: docu config for edit page

Co-authored-by: teh_coderer <me@tehcoderer.com>
2022-11-22 14:56:17 -05:00
jose-donato
2e7eb4c9b6 New documentation website (#3526)
* fix(docs): added margin between sections

* feat: removed unused files; updated ga

* fix: juan stuff doesnt work

* fix: random fix

* moon at noon

* fix: update docusaurus config

* Update controller_doc_classes.py

* fix: temp fix

* fix: temp fix

* Update controller_doc_classes.py

* fix: remove old content

* fix: taggfix

* init

* fix: styling and moved file

* Update generate_terminal_markdown.py

* fix: removed unused images

* fix: port new files

* Update generate_sdk_markdown.py

* Update controller_doc_classes.py

Co-authored-by: teh_coderer <me@tehcoderer.com>
2022-11-22 16:47:03 +00:00
montezdesousa
cd420c51c7 New format for SDK documentation (#3211)
* example changes in slopes

* change lettering size and side bar capitalization

* revert back to Fira

* start automatic website generation

* this was autogen

* add examples to slopes model

* generate slopes doc

* change to _index.md

* allow italic formatting

* fix regex

* option to regenerate paths

* update alt docs

* fix generate

* update alt

* fix generate

* update common

* target italic only for types

* format alt

* format italic common

* add sig indentation

* update sig indent alt

* update common ident

* add todo

* generate docstrings for all menus

* fix maxdd

* fix returns font size

* fix keys docs

* fix more docstrings

* escape literal symbols

* escape literal symbols

* reformat keys

* format opt

* remove literal escape

* remove another literal escape

* remove another literal escape

* unindent returns

* update docs return unindent

* add comma in last arg

* fix funcs without params

* fix signature

* compact some code

* refactor some more code

* refactor some code

* some final cleanup

* write docstrings

* change main

* move futures paths

* generate futures docs

* add external axes references

* fix typo

* revert to double docstring

* fix small bug

* remove docs folder

* generate.py in website folder

* add forecast to docs

* clear some warnings

* fix underscore

* remove cite

* refresh website docs

* fix forecast docstrings

* fix po

* fix po docs and remove italic

* fix more docstrings

* remove last warning

* codespell

* flake8

* exclude website contente from flake

* noqa on optimizer

* update website

* fix mypy

* remove setup from mypy

* mypy to openbbterminal

* update precommit

* pylint

* try to remove sdk loading issue

* avoid logging on test

Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com>
2022-11-09 13:00:10 +00:00
Wonhyeong Seo
ddcd52368d Order sdk part of main.yml (#2906)
* fix: Order sdk part of main.yml

resolve https://github.com/OpenBB-finance/OpenBBTerminal/issues/2780

* New layout

* Fixed file format

Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com>
Co-authored-by: colin99d <colin99delahunty@gmail.com>
Co-authored-by: Colin Delahunty <72827203+colin99d@users.noreply.github.com>
2022-10-24 17:59:00 +02:00
Colin Delahunty
7f1b3db5ad Rename sdk to SDK (#2968)
* Rename sdk to SDK

* Added README

* Fixed test
2022-10-21 10:11:03 +02:00
hjoaquim
7136806103 Renaming api to sdk (#2897)
* renamed api to sdk

* changing docstrings and comments

* changing documentation

* changing .md files

* sdk to SDK

* fix imports on dashboards

* fixed the website docs generator

* re-generate website docs

Co-authored-by: Chavithra <chavithra@gmail.com>
Co-authored-by: James Maslek <jmaslek11@gmail.com>
2022-10-18 12:02:40 -04:00
minhhoang1023
cfd2a03d2c Update SDK Hugo server (#2822)
Co-authored-by: Colin Delahunty <72827203+colin99d@users.noreply.github.com>
2022-10-14 11:53:34 +01:00