-
Notifications
You must be signed in to change notification settings - Fork 27.7k
Improve docs search engine indexing #32838
Copy link
Copy link
Closed
Labels
high prioritymodule: doc infraRelated to pytorch.org/docs, deployment of, and servingRelated to pytorch.org/docs, deployment of, and servingmodule: docsRelated to our documentation, both in docs/ and docblocksRelated to our documentation, both in docs/ and docblockstriagedThis issue has been looked at a team member, and triaged and prioritized into an appropriate moduleThis issue has been looked at a team member, and triaged and prioritized into an appropriate module
Metadata
Metadata
Assignees
Labels
high prioritymodule: doc infraRelated to pytorch.org/docs, deployment of, and servingRelated to pytorch.org/docs, deployment of, and servingmodule: docsRelated to our documentation, both in docs/ and docblocksRelated to our documentation, both in docs/ and docblockstriagedThis issue has been looked at a team member, and triaged and prioritized into an appropriate moduleThis issue has been looked at a team member, and triaged and prioritized into an appropriate module
📚 Documentation
There's no way to access api from search engine in one click.
I find it's very hard to search pytorch api from search engine. A typical example would be seaching
pytorch conv2d, the top result points tohttps://pytorch.org/docs/stable/nn.htmlwithout the heading hash#conv2d.In most cases, it's sth like the following img, where there's a
jump to xxxlink to the hashed urlhttps://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch#BodyI'm not sure what's missing here, a quick search seems to suggest search engine need an unique id in headings like
<h4 id="xxx"></h4>to tell the heading structure.The search bar in the doc page definitely works, It's also nice to have one click search engine access.
cc @ezyang @gchanan @zou3519