jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-27 12:40:35 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
5c2394d63bbc8d2919894544f45ba9aff659cb5f
OpenBB/docs
History
Colin Delahunty 0b33cb45f8 Adds auto yaml generation (#2587) 
* Began working on docs creator

* Added fixes

* More

* More

* Adding autogen_try.py for OpenBB API doc generation

* OpenBB API docs gen try

* Fixed

* Added fixes

* Added fixes

* subs -> sub

* Updated docs

* Updated docs

Co-authored-by: Chavithra PARANA <chavithra@gmail.com>
2022-09-23 16:43:34 +01:00
..
_templates
Add analytics beacons to hugo and readthedocs (#917)
2021-11-09 21:48:26 +03:00
code
Fix bugs, remove feargeed and improve help messages (#1767)
2022-05-05 18:18:58 +03:00
application mapping.drawio
Adds readme link to conda installation directions; Adds drawio app map (#528)
2021-07-04 07:03:54 +01:00
conf.py
Updating some names (#1575)
2022-03-29 09:46:26 -04:00
generate.py
Adds auto yaml generation (#2587)
2022-09-23 16:43:34 +01:00
index.rst
Updating some names (#1575)
2022-03-29 09:46:26 -04:00
make.bat
Coingecko feature branch (#521)
2021-07-04 07:03:32 +01:00
Makefile
Add sphinx documentation
2021-04-30 01:10:47 +03:00
README.md
Updating some names (#1575)
2022-03-29 09:46:26 -04:00

README.md

OpenBB Terminal Code Documentation

Requirements:

  • sphinx
  • myst_parser

The requirements.txt file that mentions myst_parser is needed for readthedocs.io to build the documentation automatically.

Usage:

In the docs folder execute:

rm -rf code && sphinx-apidoc ../openbb_terminal/ -o ./code
make html