Hacker News Board Hacker News, browsed like a classic message board
Live data from Hacker News

Show HN: Pythondocs.xyz – Live search for Python documentation

pythondocs.xyz

Post reply on HN
Print view View original

11–16 of 16 posts

Re: Show HN: Pythondocs.xyz – Live search for Python documentation

#11

Post by westurner »

azeirah wrote: post #6
clircle wrote: post #3

Does python not have built in documentation search? In R I use `??searchterm`.

It has help(), but I don't think there's a nice search feature included. I mean you could use string methods to search for something of course, help just returns a string. Then again, it's Python. There's probably some kind of import search from helpTools Or something among those lines, because... it always has this kind of stuff

The `pydoc` / `python -m pydoc` module doesn't do search; it would be O(n) for every search like grep without e.g. a sphinx searchindex: https://docs.python.org/3/library/pydoc.html

Sphinx searchindex.js does Porter stemming for English and other languages: https://github.com/sphinx-doc/sphinx/blob/5.x/sphinx/search/...

sphinxcontrib.websupport.search supports Xapian, Whoosh (Python), and null: https://github.com/sphinx-doc/sphinxcontrib-websupport/blob/...

sphinx-elasticsearch https://github.com/zeitonline/sphinx_elasticsearch :

> This is a stand-alone extraction of the functionality used by readthedocs.org, compatible with elasticsearch-6.

MeiliSearch (rust) compared with ElasticSearch (java), Algolia, TypeSense (C++): https://docs.meilisearch.com/learn/what_is_meilisearch/compa...

Is there a good way to index each sphinx doc set's searchindex.js?

Re: Show HN: Pythondocs.xyz – Live search for Python documentation

#13

Post by lepture »

amanzi wrote: post #12

Looks like it was a fun project but I prefer the flexibility of https://devdocs.io as I can keep all my framework docs searchable from one place. Also the instant lookup in DevDocs is super useful, especially for Python: https://devdocs.io/python~3.10/

I agree. And the search results are not good in pythonsocs.xyz. Although I’ve upvoted this thread.

Re: Show HN: Pythondocs.xyz – Live search for Python documentation

#14

Post by showmecode »

This may be a weird ask but it would be great if you could provide more emphasis to source code links for standard library results. E.g. searching for heapq would also show a link to https://github.com/python/cpython/blob/main/Lib/heapq.py

I know these links are already at the very top of most pages in the python documentation but they are easily missed and it would be good for search tools to provide a nudge to the actual source.

Re: Show HN: Pythondocs.xyz – Live search for Python documentation

#15

Post by danosull »

lepture wrote: post #13
amanzi wrote: post #12

Looks like it was a fun project but I prefer the flexibility of https://devdocs.io as I can keep all my framework docs searchable from one place. Also the instant lookup in DevDocs is super useful, especially for Python: https://devdocs.io/python~3.10/

I agree. And the search results are not good in pythonsocs.xyz. Although I’ve upvoted this thread.

Useful comments, thanks!

Better search results is my next big feature. I'm thinking about "sort by relevance", improved keyword and Python language parsing, and so on.

And DevDocs is great :)

Re: Show HN: Pythondocs.xyz – Live search for Python documentation

#16

Post by danosull »

showmecode wrote: post #14

This may be a weird ask but it would be great if you could provide more emphasis to source code links for standard library results. E.g. searching for heapq would also show a link to https://github.com/python/cpython/blob/main/Lib/heapq.py I know these links are already at the very top of most pages in the python documentation but they are easily missed and it would be good for search tools to provide a nudge to the…

That's a great, suggestion thank you.

A related thought is that I'd like to pull out results like built-in functions and Standard Library modules to make them more prominent, and perhaps a link to the source code could be presented alongside...

Post reply on HN