openmicroanalysis / pyxray

Definitions and properties of X-ray transitions
MIT License
6 stars 4 forks source link

Add sphinx documentation #12

Closed drix00 closed 5 years ago

drix00 commented 5 years ago

I add sphinx documentation to the project. I use the README.rst for the main documentation and add the API Reference, which is generated using sphinx-apidoc.

Thing to do before we merge with master:

codecov-io commented 5 years ago

Codecov Report

Merging #12 into master will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #12   +/-   ##
=======================================
  Coverage   84.13%   84.13%           
=======================================
  Files          18       18           
  Lines        2779     2779           
=======================================
  Hits         2338     2338           
  Misses        441      441

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update f0a1e64...4755b53. Read the comment docs.