Skip to content

add docs for bot api 3.0 modules - #684

Merged
Eldinnie merged 3 commits into
python-telegram-bot:docs_updatefrom
jeffffc:paymentdocs
Jul 19, 2017
Merged

add docs for bot api 3.0 modules#684
Eldinnie merged 3 commits into
python-telegram-bot:docs_updatefrom
jeffffc:paymentdocs

Conversation

@jeffffc

@jeffffc jeffffc commented Jun 22, 2017

Copy link
Copy Markdown
Contributor

however, readthedocs failed to build the docs because of 87b096c specifying sphinx of minimum version 1.5.4 while RTD is default at 1.5.3
i think we have to either:

  1. specify sphinx==1.5.4 at requirements.txt, which should not be the case because it is not a must for all users to install sphinx, or:
  2. specify it at docs/requirements-docs.txt and force RTD to install the dependencies there (need config at RTD)

@Eldinnie Eldinnie added the ⚙️ documentation affected functionality: documentation label Jun 22, 2017
@rahiel

rahiel commented Jul 17, 2017

Copy link
Copy Markdown
Contributor

Thanks for your contribution! This looks good to merge.

@jsmnbom

jsmnbom commented Jul 17, 2017

Copy link
Copy Markdown
Member

Please wait for approval by @Eldinnie, since I know he's working on docs stuff :)

@Eldinnie

Copy link
Copy Markdown
Member

Looks good but one question. Please remove the :undoc-members:

@Eldinnie Eldinnie self-assigned this Jul 19, 2017
@Eldinnie Eldinnie added 📋 pending-reply work status: pending-reply and removed 📋 pending-merge work status: pending-merge labels Jul 19, 2017
@jeffffc

jeffffc commented Jul 19, 2017

Copy link
Copy Markdown
Contributor Author

@Eldinnie Done, thanks for the review. But what about the sphinx version issue? is it solved?

@jsmnbom

jsmnbom commented Jul 19, 2017

Copy link
Copy Markdown
Member

@Eldinnie and @rahiel Is this superseeded by #728 and #729 ?

@Eldinnie

Copy link
Copy Markdown
Member

No, this is seperate, adds the new classes to the toctree. Also one last remark @jeffffc can you add all these files to docs/source/telegram.rst in their alphabetical place? Else they won;t show up at all.

@bomjacob In #728 I update the docs in the files. This one adds them to the actual docs build.

@jsmnbom

jsmnbom commented Jul 19, 2017

Copy link
Copy Markdown
Member

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?

@jsmnbom
jsmnbom changed the base branch from master to docs_update July 19, 2017 11:05
@Eldinnie

Copy link
Copy Markdown
Member

Oops, forgot these are already integrated in #728 . Thanks for your effort!
Closing

@Eldinnie Eldinnie closed this Jul 19, 2017
@rahiel

rahiel commented Jul 19, 2017

Copy link
Copy Markdown
Contributor

I'd still like this to be merged first, then #728.

@rahiel rahiel reopened this Jul 19, 2017
@rahiel
rahiel changed the base branch from docs_update to master July 19, 2017 18:45
@rahiel
rahiel changed the base branch from master to docs_update July 19, 2017 18:53
@Eldinnie
Eldinnie merged commit d1e0016 into python-telegram-bot:docs_update Jul 19, 2017
Eldinnie added a commit that referenced this pull request Jul 21, 2017
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
Eldinnie added a commit that referenced this pull request Jul 21, 2017
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
@github-actions github-actions Bot locked and limited conversation to collaborators Aug 23, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

⚙️ documentation affected functionality: documentation 📋 pending-reply work status: pending-reply

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants