mattlisiv / newsapi-python

A Python Client for News API
MIT License
375 stars 130 forks source link

Create documentation source RST #55

Closed bsolomon1124 closed 4 years ago

bsolomon1124 commented 4 years ago

Steps to render in local development:

python3 -m venv newsapi-dev
source ./newsapi-dev/bin/activate
# [cd newsapi-python/]
python -m pip install -e .
python -m pip install -r requirements-dev.txt
cd docs/
make clean && make html
open build/html/index.html

Connecting to readthedocs.io:

https://github.com/readthedocs/readthedocs.org/blob/master/README.rst#quickstart-for-github-hosted-projects

FYI @mattlisiv , it looks like you'd need to be the one to actually add this to Read The Docs. (From my account there, I'm only able to see repos under bsolomon1124/.)

Here's a sample from local development:

Screen Shot 2019-09-07 at 7 24 10 PM

mattlisiv commented 4 years ago

Awesome. Added! https://newsapi-python.readthedocs.io