Skip to content

Improve docs search engine indexing #32838

@josherich

Description

@josherich

📚 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 to https://pytorch.org/docs/stable/nn.html without the heading hash #conv2d.

Screen Shot 2020-01-27 at 12 28 28 PM

In most cases, it's sth like the following img, where there's a jump to xxx link to the hashed url https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch#Body

Screen Shot 2020-01-30 at 2 40 14 PM

I'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

Metadata

Metadata

Assignees

Labels

high prioritymodule: doc infraRelated to pytorch.org/docs, deployment of, and servingmodule: docsRelated to our documentation, both in docs/ and docblockstriagedThis issue has been looked at a team member, and triaged and prioritized into an appropriate module

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions