jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-27 04:31:13 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
9f9aaf27894afe8940359acb2397daac1fcf9dd3
OpenBB/docs
History
Theodore Aptekarev 2ea3006c07 Update readthedocs creation pipeline #859 (#895) 
* 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
2021-11-01 21:11:29 +00:00
..
code
Update readthedocs creation pipeline #859 (#895)
2021-11-01 21:11:29 +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
Remove unused import
2021-04-30 01:49:24 +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
Update readthedocs creation pipeline #859 (#895)
2021-11-01 21:11:29 +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:

sphinx-apidoc ../gamestonk_terminal/ -o ./code
make html