[FEATURE] First try with pydata theme

[jpfeuffer]

[jpfeuffer]

Instead of rocket icon, we could have binder icon.

I envision having different docs on the main header:

• User guide
• Contributors guide
• API docs
• Link to C++ docs (external)

When we fix the structure, we will have a left sidebar as usual. (Currently, everything goes automatically to the header)

[timosachsenberg]

any update here?

[jpfeuffer]

Hmm unfortunately pydata is really really slow with autosummary: https://github.com/pydata/pydata-sphinx-theme/issues/889

From 300 to 1000s build time on RTD. https://pyopenms.readthedocs.io/en/pydata-theme/index.html

[jpfeuffer]

@timosachsenberg Still waiting for feedback from people

[timosachsenberg]

Hmm unfortunately pydata is really really slow with autosummary: pydata/pydata-sphinx-theme#889

From 300 to 1000s build time on RTD. https://pyopenms.readthedocs.io/en/pydata-theme/index.html

hmm bummer... but do you consider this still ok-ish?

[matteopilz]

300 - 1000s are still fine I would say, Is that with building everything or only files changed?

[jpfeuffer]

Everything. We can also try some of the suggestions in the link from the issue: https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/performance.html#build-performance-and-size

Let me know if you like it in general. I still want to do quite some smaller changes but the overall restructuring is finished.

[timosachsenberg]

I think it is great if it gets the side panel back.

[jpfeuffer]

It has. You need to click on a top bar link first, since the sidebar contents depend on this.

[matteopilz]

I also like it. If we exclude the _autosummary folder from the sidebar, the building time will probably be shorter.

[timosachsenberg]

ah ok and the top bar would not contain that many entries right? is there a working version up somewhere to get an idea how this would look like for the user?

[jpfeuffer]

Hmm unfortunately pydata is really really slow with autosummary: pydata/pydata-sphinx-theme#889

From 300 to 1000s build time on RTD. https://pyopenms.readthedocs.io/en/pydata-theme/index.html

Yep. See the second link in my comment.

[matteopilz]

Did you test it without autosummary?

[jpfeuffer]

You mean completely without autosummary? No, we need it for the API. I did not test the autosummary exclusion from the sidebar yet.

Of course, on a local computer it is usually relatively fast. And once the autosummary is generated it is even faster. But a full build on RTD is slow.

[matteopilz]

I meant excluding it from the sidebar.

[timosachsenberg]

• navigation structure is duplicated in sidebar / main text

• seems to render slower on my PC (8k display). Can someone confirm?

[jpfeuffer]

a) was always the case. we can hide the TOC in the text. b) might also be related to caching? but I would not be surprised if it is a bit slower. It is not very noticeable for me though.

[timosachsenberg]

some images are not drawn https://pyopenms.readthedocs.io/en/pydata-theme/user_guide/ms_data.html

[jpfeuffer]

I could speed up generation by removing tocs from the API docs. Not ideally but also not too bad. Will merge

[timosachsenberg]

hmm I get a huge left border with adds now

[timosachsenberg]

can the "User guide" be enabled by default and the sections expanded? so it looks a bit mroe like this:

[jpfeuffer]

I think it has to have a landing page.

Yes toc can be expanded. See conf.py.

Ethical ads placement is default. See https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/readthedocs.html#add-ethical-advertisements-to-your-sidebar on how to change.

[timosachsenberg]

• I think if expanded the adds are not a problem. maybe than landing page is also not an issue