mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-27 12:40:35 +00:00
ddcd52368d
* 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>
OpenBB Terminal Code Documentation
Creating Hugo SDK Documentation
To generate markdown files for the Hugo website do the following:
- Go to the openbb directory:
cd ~/OpenBBTerminal - Generate the documentation:
python docs/generate.py - Change into the website directory:
cd website - Run the hugo server to confirm changes applied:
hugo server -D
Creating Sphinx 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