[HN Gopher] Show HN: Pythondocs.xyz - Live search for Python doc...
___________________________________________________________________
Show HN: Pythondocs.xyz - Live search for Python documentation
Hi everyone! I've been working on a web search interface for
Python's documentation as a personal project, and I think it's
ready for other people to use... Please give it a go (and join me
in praying to the server gods): https://pythondocs.xyz/ Here's
the tech stack for those interested: - Parser: Beautiful Soup +
Mozilla Bleach - Database: in-memory SQLite (aiosqlite) +
SQLAlchemy - Web server: FastAPI + Uvicorn + Jinja2 - Front end:
Tailwind CSS + htmx + Alpine.js I have ideas for future
improvements but hopefully the current version is useful to
someone. Let me know what you think!
Author : danosull
Score : 41 points
Date : 2022-05-09 18:27 UTC (4 hours ago)
(HTM) web link (pythondocs.xyz)
(TXT) w3m dump (pythondocs.xyz)
| ystad wrote:
| Looks really nice!.
|
| Feature-request: Would love auto-suggest as I type. one of my
| favorite example(s) is Algolia's doc search
| https://www.algolia.com/doc/
| danosull wrote:
| Thank you!
|
| And great feature suggestion. I'll put it on the list.
| clircle wrote:
| Does python not have built in documentation search? In R I use
| `??searchterm`.
| azeirah wrote:
| 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
| thealistra wrote:
| I tried "typeof" and "is" and results were not what I wanted.
|
| Is there indexing for language keywords?
| danosull wrote:
| Not right now, although it's something I'm interested in
| adding!
|
| You can get usually get quite good results by selecting
| Standard Library and Definitions, though.
|
| "is" is a special case as I currently enforce a 3 character
| minimum to keep the number of live search results sane.
| drcongo wrote:
| Small feedback: I tried `Iterable` as the search term and there's
| no mention of `typing.Iterable` on the first page - case
| sensitivity may help?
| danosull wrote:
| Very useful feedback, thank you.
|
| The ordering of search results is currently very crude - it's
| basically just alphabetical. I plan to add "order by relevance"
| in the future, and I'll definitely bear capitalisation in mind.
| [deleted]
___________________________________________________________________
(page generated 2022-05-09 23:00 UTC)