Update readthedocs creation pipeline OpenBB-finance#859 (OpenBB-finan…

…ce#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
Mysingen · Nov 1, 2021 · 2ea3006 · 2ea3006
1 parent b374e84
commit 2ea3006
Show file tree

Hide file tree

Showing 53 changed files with 3,114 additions and 339 deletions.
diff --git a/.gitignore b/.gitignore
@@ -26,3 +26,6 @@ jupyterlab/*/.ipynb_checkpoints
 jupyterlab/*/*.tsbuildinfo
 jupyterlab/*/ui-tests/test-results/
 jupyterlab/*/ui-tests/tests/*.ts-snapshots/
+
+# Sphinx documentation build files
+docs/_build
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,15 @@
+# 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
+```
diff --git a/docs/code.rst b/docs/code.rst