jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-27 20:42:26 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
17c9b01fadbebf129ea1e90fbaf38676cb6d16c6
OpenBB/docs/README.md
Theodore Aptekarev 79bacf3f51 Fix mypy hook and Resolve documentation errors (#1008) 
* 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
2021-12-01 23:19:50 +00:00

331 B
Vendored
Raw Blame History

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:

rm -rf code && sphinx-apidoc ../gamestonk_terminal/ -o ./code
make html