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

Updated API docs #57

Closed ojeda-e closed 3 years ago

ojeda-e commented 3 years ago

This is a preliminary version of updated API docs. It may help to fix #56

This PR includes:

getting_started.rst is not really ready.

But maybe I can have some review for what I have so far @lilyminium? Any suggestions are appreciated @orbeckst @IAlibay @fiona-naughton

pep8speaks commented 3 years ago

Hello @ojeda-e! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! :beers:

Comment last updated at 2021-07-28 05:26:20 UTC
codecov[bot] commented 3 years ago

Codecov Report

Merging #57 (f1be076) into main (d991211) will not change coverage. The diff coverage is 100.00%.

ojeda-e commented 3 years ago

Thanks for your comments @orbeckst. I added the requested changes. API docs are now split into 3 pages.