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
af785d236ac72e044aa41146f782fc9eaed36071
OpenBB/docs
History
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
..
_templates
Add analytics beacons to hugo and readthedocs (#917)
2021-11-09 21:48:26 +03:00
code
Fix mypy hook and Resolve documentation errors (#1008)
2021-12-01 23:19:50 +00:00
application mapping.drawio
Adds readme link to conda installation directions; Adds drawio app map (#528)
2021-07-04 07:03:54 +01:00
conf.py
Add analytics beacons to hugo and readthedocs (#917)
2021-11-09 21:48:26 +03:00
index.rst
Update readthedocs creation pipeline #859 (#895)
2021-11-01 21:11:29 +00:00
make.bat
Coingecko feature branch (#521)
2021-07-04 07:03:32 +01:00
Makefile
Add sphinx documentation
2021-04-30 01:10:47 +03:00
README.md
Fix mypy hook and Resolve documentation errors (#1008)
2021-12-01 23:19:50 +00:00

README.md

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