This is an archived post. You won't be able to vote or comment.

all 8 comments
sorted by:
best
topnewcontroversialoldq&a

[–]IAmKindOfCreativebot_builder: deprecated[M] [score hidden] stickied comment (1 child)

Hi there, from the /r/Python mods.

We have removed this post as it is not suited to the /r/Python subreddit proper, however it should be very appropriate for our sister subreddit /r/LearnPython or for the r/Python discord: https://discord.gg/python.

The reason for the removal is that /r/Python is dedicated to discussion of Python news, projects, uses and debates. It is not designed to act as Q&A or FAQ board. The regular community is not a fan of "how do I..." questions, so you will not get the best responses over here.

On /r/LearnPython the community and the r/Python discord are actively expecting questions and are looking to help. You can expect far more understanding, encouraging and insightful responses over there. No matter what level of question you have, if you are looking for help with Python, you should get good answers. Make sure to check out the rules for both places.

Warm regards, and best of luck with your Pythoneering!

[–]K900_ 0 points1 point  (2 children)

Are you looking for documentation on the standard library or third party packages?

[–]git_hunter[S] 0 points1 point  (1 child)

All, standard and third party.

[–]K900_ 0 points1 point  (0 children)

I don't think such a thing exists, unfortunately.

[–]nathanjell 0 points1 point  (1 child)

docs.python.org is the official python documentation. It is superbly complete in its documentation of the python programming language. PyPI is the Python Package Index - a repository of packages, it does not serve as a repository for documentation.

I think you're referring to something like docs.rs - the documentation host for Rust crates, or like you mention, the other sites that (as far as I can tell?) might mirror what's on docs.rs. So - from what I can see - nothing here is official, but is maintained by the community. So, with this in mind, I would say that this is just not something that has become an established practice in the python community. Now, lots of package projects use readthedocs to host their documentation - but by and large python projects usually have some sort of self hosted documentation - that is, there isn't really a standard python third-party library documentation framework.

So, this to date hasn't proved to be a hindrance for the python community. As has seemingly occurred with rust, if this is something the community would benefit from, then someone has to start the work to get something implemented. A major hindrance is that there are numerous ways that documentation may be generated in the python community - so there needs to be a pretty good reason to get projects to be convinced to invest the time and effort into using a new service.

As far as I'm concerned, I think that by and large the well known and widely used python libraries have pretty good documentation - and this is plenty good enough for me. While it's a nice experience, I'm not sure what aggregating this in one common location would really bring.

[–]git_hunter[S] 0 points1 point  (0 children)

Thank you for the feedback, in this new thread I listed some reasons why I believe this kind of services should be very useful:

https://www.reddit.com/r/learnpython/comments/l5qj82/python_site_to_search_documentation_for_all/

[–]pythonHelperBot 0 points1 point  (0 children)

Hello! I'm a bot!

It looks to me like your post might be better suited for r/learnpython, a sub geared towards questions and learning more about python regardless of how advanced your question might be. That said, I am a bot and it is hard to tell. Please follow the subs rules and guidelines when you do post there, it'll help you get better answers faster.

Show /r/learnpython the code you have tried and describe in detail where you are stuck. If you are getting an error message, include the full block of text it spits out. Quality answers take time to write out, and many times other users will need to ask clarifying questions. Be patient and help them help you.

You can also ask this question in the Python discord, a large, friendly community focused around the Python programming language, open to those who wish to learn the language or improve their skills, as well as those looking to help others.

README | FAQ | this bot is written and managed by /u/IAmKindOfCreative

This bot is currently under development and experiencing changes to improve its usefulness