search

qiskit-community / qiskit-dynamics

Tools for building and solving models of quantum systems in Qiskit
https://qiskit-community.github.io/qiskit-dynamics/
Apache License 2.0
105 stars 61 forks source link

Update to new qiskit docs theme #246

Closed DanPuzzuoli closed 1 year ago

DanPuzzuoli commented 1 year ago

Summary

Closes #244

Update to new qiskit docs theme.

Eric-Arellano commented 1 year ago

I take back my approval. I don't recommend landing this until reorganizing API docs to not have dedicated HTML pages for methods.

This is because the new Furo theme includes the entire site in the left table of contents. That results in the HTML page size increasing by 33kb and your docs build speed going from 5 minutes to 9 minutes.

As discussed in Slack, I will help you out with new autodoc templates soonish.

arnaucasau commented 1 year ago

@DanPuzzuoli @Eric-Arellano The API docs have been reorganised in https://github.com/Qiskit-Extensions/qiskit-dynamics/pull/264. After updating this branch with the new changes on the main branch, we should be able to see if we have achieved the improvement needed 👍

DanPuzzuoli commented 1 year ago

@Eric-Arellano is this good to go? Thanks for both of your help @Eric-Arellano and @arnaucasau

Eric-Arellano commented 1 year ago

@arnaucasau wanted to check on Monday that the build times and page sizes are acceptable. He's OOO now (Spain hours), but DMed me that he plans to review on Monday :)

Eric-Arellano commented 1 year ago

@DanPuzzuoli fyi neither of us have write access. Not sure if you need someone else to approve this also.

DanPuzzuoli commented 1 year ago

Thanks @arnaucasau @Eric-Arellano . You both know best for this stuff, so with your approval I'll just bypass branch protections for this one.