Created readthedocs configuration (#151)

* renamed doc folder and created rtd config

* removed requirements.txt file

* Updated rtd config

* Added include option in pyproject

.readthedocs.yml

@@ -0,0 +1,25 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF
+formats:
+  - pdf
+
+build:
+  image: latest
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.8
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+          - docs

.travis.yml

@@ -13,5 +13,5 @@ install:
 
 script:
   - poetry run pytest
-  - poetry run sphinx-build -b html doc doc/_build/html
+  - poetry run sphinx-build -b html docs docs/_build/html
   - python setup.py install # Ideally replace with poetry install

README.md

@@ -128,10 +128,10 @@ https://tradingmate.readthedocs.io
 
 You can build it locally from the repo root folder:
 ```
-poetry run sphinx-build -b html doc doc/_build/html
+poetry run sphinx-build -b html docs docs/_build/html
 ```
 
-The generated html files will be under `doc/_build/html`.
+The generated html files will be under `docs/_build/html`.
 
 ## Contributing
 

pyproject.toml

@@ -4,6 +4,10 @@ version = "2.2.0"
 description = "Trading portfolio and real time stock price monitor"
 authors = ["Alberto Cardellini"]
 license = "MIT"
+packages = [
+    { include = "src" }
+]
+include = ["config/config.json", "data/trading_log.json"]
 
 [tool.poetry.dependencies]
 python = ">=3.6"