mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-27 20:42:26 +00:00
2ea3006c07
* Add built documentation to gitignore * Add documentation creation readme and requirements * Change manually generated code docs to automatic * Move myst_parser documentation requirement to pyproject.toml * Update poetry and requirements files for the readthedocs build to work * Add prediction extras to requirements-full
16 lines
285 B
Markdown
Vendored
16 lines
285 B
Markdown
Vendored
# Gamestonk 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:
|
|
|
|
```bash
|
|
sphinx-apidoc ../gamestonk_terminal/ -o ./code
|
|
make html
|
|
```
|