Files
OpenBB/docs/README.md
2022-03-28 22:49:25 -04:00

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
```