Skip to content

Add info on documentation to CONTRIBUTING.rst #1500

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.

Sign up for GitHub

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

Jump to bottom
Merged
Eldinnie merged 1 commit into from
Sep 9, 2019
Merged

Add info on documentation to CONTRIBUTING.rst #1500

Eldinnie merged 1 commit into from
Sep 9, 2019

Conversation

@plammens
Copy link
Contributor

@plammens plammens commented Sep 1, 2019

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

Bibo-Joshi
Bibo-Joshi reviewed Sep 1, 2019
View reviewed changes
Copy link
Member

@Bibo-Joshi Bibo-Joshi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@Poolitzer
Copy link
Member

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
Copy link
Contributor Author

plammens commented Sep 2, 2019 •
edited
Loading

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.

Poolitzer
Poolitzer requested changes Sep 5, 2019
View reviewed changes
Copy link
Member

@Poolitzer Poolitzer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@plammens
docs: Add info on documentation to CONTRIBUTING.rst
857b5ee 
I didn't find this information elsewhere in the repository;
I thought it might be useful for new contributors.
@plammens
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.

@Bibo-Joshi Bibo-Joshi added the ⚙️ documentation affected functionality: documentation label Sep 6, 2019
@Eldinnie
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
@plammens plammens deleted the patch-1 branch September 9, 2019 08:05
@github-actions github-actions bot locked and limited conversation to collaborators Aug 20, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@Poolitzer Poolitzer Poolitzer requested changes

@Bibo-Joshi Bibo-Joshi Bibo-Joshi approved these changes

Assignees

No one assigned

Labels

⚙️ documentation affected functionality: documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@plammens @Poolitzer @Eldinnie @Bibo-Joshi