Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create documentation source RST #55

Merged
merged 3 commits into from Sep 12, 2019
Merged

Create documentation source RST #55

merged 3 commits into from Sep 12, 2019

Conversation

bsolomon1124
Copy link
Collaborator

@bsolomon1124 bsolomon1124 commented Sep 7, 2019

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

@bsolomon1124 bsolomon1124 changed the title Initial commit: create documentation source RST Create documentation source RST Sep 8, 2019
@mattlisiv mattlisiv merged commit bc8f0a4 into mattlisiv:master Sep 12, 2019
@mattlisiv
Copy link
Owner

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants