Docs link python classes to docs #2633

[eldbud]

Resolves item number 2 on the original message in #2633 - link to python docs.

Added intersphinx to conf.py, also minor docs mending.

I am uncertain whether i should add more links to any additional libraries apart from the python builtin library. Please do tell if you can think of any library that we could benefit from including in the intersphinx.

[Bibo-Joshi]

Thanks for the PR!

one could think of linking to the docs of APScheduler for the JobQueue 🤔
There are probably a number of places where stuff from the python/APS docs is mentioned in a way that doesn't automatically reference is by adding intersphinx. But I guess, we'll find them one by one … What you could do is run sphinx with the nitpicky option as mentioned in #2633 (comment) which might tell you about some of those places already.

BTW, would you mind rebasing your branch onto v14 to clean up the commit history? :D

[eldbud]

BTW, would you mind rebasing your branch onto v14 to clean up the commit history?

when i tried "rebase current onto selected", where "selected" is the v14 branch, i got this error message:
Couldn't shelve local uncommitted changes: Shelving changes failed: Uncommitted changes before rebase [Changes]

i don't have any uncommitted changes, except for some odd reason the ptb_urllib3 file (or folder? i don't know), which i never touched, and i do not include in my commits.

@Bibo-Joshi what should i do to resolve this?

[Bibo-Joshi]

Please try to reset the changes in ptb_urllib3 as described in the contribution guide. An alternative to rebasing would be to create a new branch from the upt-to-date v14 branch and cherry pick your RTD-related commits into that branch. If neither of this works, let's discuss that in PM or in @pythontelegrambotdev :)

[eldbud]

Please try to reset the changes in ptb_urllib3 as described in the contribution guide

upon searching "ptb_urllib3" and also "reset" in the contribution guide page, i get zero results. where can i see the instructions about this?

ok i ran git submodule update --init --recursive, but it seems that the urllib3 file/folder is still in the "changes" list of the commit window

[Bibo-Joshi]

@eldbud search for "vendor" ;)

[github-actions]

Hey there. Relax, I am just a little warning for the maintainers to release directly after merging your PR, otherwise we have broken examples and people might get confused :)

[eldbud]

@eldbud search for "vendor" ;)

yes found it, ran the command, updated v14 from upstream, merged v14 into my branch, ran the git submodule update --init --recursive again, the urllib3 file is still in the changes list, and unable to rebase. what should i do next?

Edit: I also now created a completely new branch from a freshly updated v14, and the urllib3 file is still in the changes list. why is this there? i'm lost here

[eldbud]

Also, now i see i have conflicting files with the base branch. do i need to merge the doc-fixes branch into my branch?

Edit: i merged doc-fixes into my branch, no conflicts happened. Now i see there are still conflicts. Not sure i understand which base branches i need to merge from, rebase onto, etc, the flow is a bit too complicated for me.

[eldbud]

What you could do is run sphinx with the nitpicky

ran with nitpicky, and it gives me many attr reference target not found messages, which i am not sure what to do about - all i found about this message is that there is a bug in python docs, and that the sphinx should be ran with nitcpicky ignore option on True.
So is this something that can be fixed on our side?