Doc update - Githubissues

aewallin / allantools

Allan deviation and related time & frequency statistics library in Python

GNU Lesser General Public License v3.0

226 stars 77 forks source link

Doc update #98

Closed fmeynadier closed 5 years ago

fmeynadier commented 5 years ago

Some clean up on the documentation

Merged "getting started" with readme
Moved dev-specific things from readme to dev
Fixed some hierarchy-level issues in some section headers
split api and functions
switched to sphinx.ext.napoleon to avoid bugs in doc compilation (https://stackoverflow.com/questions/12206334/sphinx-autosummary-toctree-contains-reference-to-nonexisting-document-warnings)
therefore had to add mathimg extension (but this won't be necessary anymore as of sphinx 1.8)

coveralls commented 5 years ago

Coverage remained the same at 84.056% when pulling b79cbdb824d68e71cfd5da75c13085bbcef7672f on fmeynadier:master into f792235a7247ceac46457ed54624a3e5403971c7 on aewallin:master.

fmeynadier commented 5 years ago

I think this fixes #55