mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-28 21:12:16 +00:00
79bacf3f51
* Make mypy pre-commit check non-strict * Fix mypy pre-commit hook * Update docstrings to be compliant with sphinx-readthedocs commonmark * Change report path to be relative to the module and not the terminal.py * Update class library documentation
18 lines
331 B
Markdown
Vendored
18 lines
331 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:
|
|
|
|
In the `docs` folder execute:
|
|
|
|
```bash
|
|
rm -rf code && sphinx-apidoc ../gamestonk_terminal/ -o ./code
|
|
make html
|
|
```
|