DocSearch

[flying-sheep]

In Action

Fixes #25

TODO

• Indices: Which projects are being indexed in our scanpy project index? How to configure that? Should searching in e.g. scanpydoc itself yield scanpy results, or should we have e.g. one index for scanpydocs and one for anndata & scanpy?

  Currently our setup means that scanpydoc would return search results for scanpy only, not itself, which is very wrong.

• Doc versions: Currently it uses the version it’s built under, as long as that version is “latest” or “stable”. Does that make sense?

[ivirshup]

Doc versions: Currently it uses the version it’s built under, as long as that version is “latest” or “stable”. Does that make sense?

Can "version" be a configuration parameter?

Which projects are being indexed in our scanpy project index

Right now, just scanpy. I'm not sure if the right way to add anndata would be with a new project or what. I'm sure at some point they'd like to start charging though.

Right now, I think it's important that we can pass through the apiKey and indexName in the config.

---

Currently, nav menu is still hidden for me:

But, I'm pretty sure adding just

.wy-nav-side { overflow: visible; }
.wy-side-scroll { overflow: inherit; }

After the algolia css is included will do the trick.

[flying-sheep]

Can "version" be a configuration parameter?

Totally, and we can still make it default to stable/latest when not set! Done.

Currently, nav menu is still hidden for me

Can’t reproduce, it works flawlessly in both Chromium and Firefox.

I assume you have some old CSS in the cache. Sometimes it takes time or deleting _build to do that

But, I'm pretty sure adding just […] After the algolia css is included will do the trick.

You can use a inspector to see which style rule applies. This one does, so that’s not necessary.

But good idea with including our style later that avoids having to use all that !important, done!

[flying-sheep]

Is it possible to index AnnData in the same index? Then searches in both projects would yield results from both.

If we want that.

[ivirshup]

Is it possible to index AnnData in the same index?

I don't know.

If we want that.

ehhh, I think it makes sense to keep them separate. Maybe useful, but also not a priority.

[ivirshup]

How do I check this out locally? I want to check if the CSS is fixed (still broken for me on the above link).

[flying-sheep]

I just tested the above link in both Chromium and Firefox and it works perfectly. What browser (version) do you use?

It works locally just as here: Check out this branch, rebuild the docs, and type.

[ivirshup]

What browser (version) do you use?

Safari mostly

It works locally just as here: Check out this branch, rebuild the docs, and type.

Stil not working. I could go into the inspector and modify the classes to get it to work though. I had gotten this working on the scanpy docs directly, I'll see if I can figure out how I did that.

[ivirshup]

All that's needed for it to work for me is:

.wy-nav-side { overflow: visible; }
.wy-side-scroll { overflow: inherit; }

That is, I can remove all of the css you add to scanpy.css here, replace it with the snippet above, and it works. I can also add this to the css you've defined here and it works.

[ivirshup]

I added a commit on top of this in #28 to show what works for me. Also works for me in chrome.

[flying-sheep]

Huh, works for me in firefox too. No idea why I didn’t do it that way 🤔