jessecooper / pyetrade

Python E-Trade API Wrapper
GNU General Public License v3.0
209 stars 97 forks source link

Modified docs for sphinx, removed html generation errors for sphinx, … #37

Closed ajshastri closed 4 years ago

ajshastri commented 4 years ago
  1. Fixed errors during make html
  2. fixed the rest of the documentation
  3. Removed the pyetrade.\exception_module for now from the pyetrade.rst to resolve errors related to module absence.
  4. Created an examples page in documentation for beginners to easily follow (orders examples pending)
  5. imported alerts to init.py to standardize import pyetrade
  6. Bumping version to 1.2.1 because of the change to init.py

@jessecooper Please let me know if you want me to change any of the above.

ajshastri commented 4 years ago

@jessecooper

The new docs should look like this

https://docsfixpyetrade.readthedocs.io/en/docs-fix/pyetrade.html#module-pyetrade.order

codecov-io commented 4 years ago

Codecov Report

Merging #37 into master will decrease coverage by 0.02%. The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #37      +/-   ##
==========================================
- Coverage   90.59%   90.57%   -0.03%     
==========================================
  Files           6        6              
  Lines         351      350       -1     
==========================================
- Hits          318      317       -1     
  Misses         33       33              
Impacted Files Coverage Δ
pyetrade/accounts.py 98.18% <ø> (ø)
pyetrade/alerts.py 100.00% <ø> (ø)
pyetrade/authorization.py 100.00% <ø> (ø)
pyetrade/market.py 84.70% <ø> (-0.18%) :arrow_down:
pyetrade/order.py 83.18% <ø> (-0.15%) :arrow_down:
pyetrade/__init__.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 9e183ea...308deec. Read the comment docs.

jessecooper commented 4 years ago

@ajshastri Thank you for the PR

jessecooper commented 4 years ago

The docs have never looks so good. Awesome job!

ajshastri commented 4 years ago

My pleasure. Nothing like learning a new library like jumping into the deep end. :D