mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-27 12:40:35 +00:00
b71abcfbf4
* quick econ fix * black * keys and feature flags * terminal name 👀 * some more replacements * some more replacements * edit pyproject * gst -> openbb * add example portfolios back to git * Update api from gst * sorry. skipping some tests * another round of names * another round of test edits * Missed some .gst refs and update timezone * water mark stuff * Fixing Names in terminal.spec and name of GTFF_DEFAULTS to OBBFF_DEFAULTS * fix more GST to OpenBB Terminal * Logging : merge conflicts with main * Revert wrong files Co-authored-by: Andrew <andrew.kenreich@gmail.com> Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt> Co-authored-by: Chavithra PARANA <chavithra@gmail.com>
18 lines
325 B
Markdown
Vendored
18 lines
325 B
Markdown
Vendored
# 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:
|
|
|
|
```bash
|
|
rm -rf code && sphinx-apidoc ../openbb_terminal/ -o ./code
|
|
make html
|
|
```
|