search

MDAnalysis / membrane-curvature

MDAnalysis tool to calculate membrane curvature.
https://membrane-curvature.readthedocs.io/
GNU General Public License v3.0
29 stars 6 forks source link

Switch to MDA rtd sphinx theme #122

Closed ojeda-e closed 7 months ago

ojeda-e commented 7 months ago

As we agreed with @IAlibay, I am here submitting changes to update the docs theme to the official one. This PR fixes #120 and #110 (opened by @orbeckst).

Description

Update docs mdanalysis-sphinx-theme with plus maintenance.

Status

It compiles locally and seems to work as expected. I'll be fixing the issues if any once it build in the CI. Thanks.

review-notebook-app[bot] commented 7 months ago

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

codecov[bot] commented 7 months ago

Codecov Report

Merging #122 (b931fad) into main (0cf4856) will not change coverage. Report is 2 commits behind head on main. The diff coverage is 100.00%.

Additional details and impacted files
ojeda-e commented 7 months ago

Is the content from the removed notebooks available elsewhere?

@orbeckst I just noticed the diff for the notebooks are misleading. The notebooks are still part of the documentation. I had to regenerate them to verify every cell works and the output is correct -the same as before-; the nb kernel was also updated to enable docs build in the CI. The content is available in the reviewnb app: https://app.reviewnb.com/MDAnalysis/membrane-curvature/pull/122/

Here are the build notebooks in the tutorial section in case you want to check:

ojeda-e commented 7 months ago

@lilyminium, if possible, would you please help me with a quick review here before I merge?

IAlibay commented 7 months ago

@ojeda-e apologies I am unlikely to have much time to look at this until the weekeend - please do re-ping me if you still need my input by then.

ojeda-e commented 7 months ago

Thanks for taking the time here @lilyminium I addressed your comments. Hopefully I didn't miss anything. Removed the editable version part, removed Sphinx from the requirements and fixed the date on the notebook.It's a bit late here, but there if there are more comments please feel free to leave them and I'll address them tomorrow.