-
Notifications
You must be signed in to change notification settings - Fork 5.7k
add docs for bot api 3.0 modules #684
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 docs for bot api 3.0 modules #684
Conversation
Thanks for your contribution! This looks good to merge. |
Please wait for approval by @Eldinnie, since I know he's working on docs stuff :) |
Looks good but one question. Please remove the :undoc-members: |
@Eldinnie Done, thanks for the review. But what about the sphinx version issue? is it solved? |
No, this is seperate, adds the new classes to the toctree. Also one last remark @jeffffc can you add all these files to @bomjacob In #728 I update the docs in the files. This one adds them to the actual docs build. |
I see. Should we merge them into docs_update instead of master, so we can compile the docs with the new docstrings and see if they are satisfactory? |
Oops, forgot these are already integrated in #728 . Thanks for your effort! |
I'd still like this to be merged first, then #728. |
Base Bot CallbackQuery Chat ChatAction ChatMember Merge pull request #684 from jeffffc/paymentdocs ChosenInlineResult Constants Error ForceReply KeyboardButton Message MessageEntity ParseMode ReplyKeyboardMarkup ReplyKeyboardRemove ReplyMarkup Update User UserProfilePhotos WebhookInfo
Base Bot CallbackQuery Chat ChatAction ChatMember Merge pull request #684 from jeffffc/paymentdocs ChosenInlineResult Constants Error ForceReply KeyboardButton Message MessageEntity ParseMode ReplyKeyboardMarkup ReplyKeyboardRemove ReplyMarkup Update User UserProfilePhotos WebhookInfo Audio ChatPhoto Contact Document File InputFile Location PhotoSize Sticker Venue Video VideoNote Voice
however, readthedocs failed to build the docs because of 87b096c specifying sphinx of minimum version
1.5.4
while RTD is default at1.5.3
i think we have to either:
sphinx==1.5.4
atrequirements.txt
, which should not be the case because it is not a must for all users to install sphinx, or:docs/requirements-docs.txt
and force RTD to install the dependencies there (need config at RTD)