Skip to content

Add readthedocs #36

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

Closed
KevinHock opened this issue Apr 25, 2017 · 9 comments
Closed

Add readthedocs #36

KevinHock opened this issue Apr 25, 2017 · 9 comments
Assignees

Comments

@KevinHock
Copy link
Collaborator

KevinHock commented Apr 25, 2017

If you look at https://github.com/trailofbits/manticore/blob/master/README.md you can see a nice link at the top to the docs. I'll write the docs once the layout is there, please see
https://www.slideshare.net/mobile/JohnCosta/how-to-readthedocs

(So the [easy] issues are good for new people who want to start contributing to look at.)

@Thalmann Thalmann changed the title [Easy] Add readthedocs Add readthedocs Apr 26, 2017
@morrme
Copy link

morrme commented Apr 27, 2017

I'd like to help with this.

@Thalmann
Copy link
Contributor

Great,

If you want we can discuss it on slack? Set me an email: mr.thalmann@gmail for invite
Else if you have any questions feel free to ask them here.

@morrme
Copy link

morrme commented Apr 27, 2017

@Thalmann thanks! i am revewing the instructions once more and i'll have questions after that.

@KevinHock
Copy link
Collaborator Author

@morrme Would you like me to help you w/ this issue?
I found the following that seem like they'll be helpful, I've never done it before though.
http://dont-be-afraid-to-commit.readthedocs.io/en/latest/documentation.html
http://docs.readthedocs.io/en/latest/getting_started.html

If it requires Admin perms you can always create a fork like I'm trying to w/ the Codeclimate issue, https://codeclimate.com/github/KevinHock/codeclimatepyt/coverage (still need to do the Travis YML stuff tonight.)

I could try my hand at it and show you what I did if you'd like. Let me know what you think.

@morrme
Copy link

morrme commented May 16, 2017

@KevinHock i sent a message on slack about this , i love the idea of doing it on a fork to get the process together. i will work on it !

@KevinHock
Copy link
Collaborator Author

Awesome, thanks @morrme :)

@KevinHock
Copy link
Collaborator Author

I kind of feel bad about this :/ But I started documenting http://pyt.readthedocs.io/en/latest/?badge=latest via https://github.com/KevinHock/rtdpyt. I'm sorry.

@morrme
Copy link

morrme commented Jun 6, 2017

you should not feel bad. i had a few troubles with mine and clearly you got past it. I initially grabbed the pyt name (by accident) for my fork and released it so that it would be available. :) glad you got it!

@KevinHock KevinHock self-assigned this Jun 30, 2017
@KevinHock
Copy link
Collaborator Author

I'm still working on documenting everything but felt it was good enough to add the badge, once I feel it's more complete I'll make the PR to move my docs/ folder to this repo. But I think I'll close this issue because I mainly wanted the cool badge.

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

No branches or pull requests

3 participants