mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-27 12:40:35 +00:00
8731fbd692
* Started auto doc generation * Created a markdown document * Added test changed to md * Created working version of new documentation * Made requested changes * Generate docs for all Co-authored-by: minhhoang1023 <40023817+minhhoang1023@users.noreply.github.com>
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