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

Add info on documentation to CONTRIBUTING.rst #1500

Merged
merged 1 commit into from Sep 9, 2019

Conversation

@plammens
Copy link
Contributor

plammens commented Sep 1, 2019

I didn't find this information elsewhere in the repository; I thought it might be useful for new contributors.

Copy link
Member

Bibo-Joshi left a comment

Yes, this would surely be helpful :)
One suggestion:

.github/CONTRIBUTING.rst Outdated Show resolved Hide resolved
@plammens plammens force-pushed the plammens:patch-1 branch from e9b9ed1 to 77934a2 Sep 1, 2019
@Poolitzer

This comment has been minimized.

Copy link
Contributor

Poolitzer commented Sep 2, 2019

this does not cover windows.

On there, you need to run sphinx-build docs\source temp_html or so :)

@plammens

This comment has been minimized.

Copy link
Contributor Author

plammens commented Sep 2, 2019

this does not cover windows.

On there, you need to run sphinx-build docs\source temp_html or so :)

Right, forgot about that. I'm using Windows, and I have installed make through cygwin, but probably its best to add the alternative in any case! I've re-amended the commit.

@plammens plammens force-pushed the plammens:patch-1 branch from 77934a2 to 9dca853 Sep 2, 2019
Copy link
Contributor

Poolitzer left a comment

uhm, there exists requirements-docs.txt in the docs folder, which people need to install with pip -r. Sorry that I only think of that now ;P

I didn't find this information elsewhere in the repository;
I thought it might be useful for new contributors.
@plammens plammens force-pushed the plammens:patch-1 branch from 9dca853 to 857b5ee Sep 5, 2019
@plammens

This comment has been minimized.

Copy link
Contributor Author

plammens commented Sep 5, 2019

uhm, there exists requirements-docs.txt in the docs folder, which people need to install with pip -r. Sorry that I only think of that now ;P

Ha! I also missed that. I've added it now.

@Eldinnie

This comment has been minimized.

Copy link
Member

Eldinnie commented Sep 9, 2019

Hi,
Thanks again for contributing!

@Eldinnie Eldinnie merged commit b38a184 into python-telegram-bot:master Sep 9, 2019
2 of 3 checks passed
2 of 3 checks passed
continuous-integration/appveyor/pr AppVeyor build failed
Details
Codacy/PR Quality Review Up to standards. A positive pull request.
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@plammens plammens deleted the plammens:patch-1 branch Sep 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.