dftlibs / xcfun

XCFun: A library of exchange-correlation functionals with arbitrary-order derivatives
https://dftlibs.org/xcfun/
Mozilla Public License 2.0
57 stars 32 forks source link

Documentation pass: building and API docs #106

Closed robertodr closed 4 years ago

robertodr commented 4 years ago

Improve XCFun docs for the API (currently confusing/outdated) and for building (completely outdated)

Squash-merge please, we don't need to keep the history for this PR.

To build locally, you need Doxygen, Sphinx, and Breathe installed. Either from the root folder of the repo with:

sphinx-build docs _build -t html

or from the docs folder with:

make html

@bast I think the documentation on dftlibs.org is completely outdated and can be safely decommissioned.

Close #32, close #4, close #88

Todos

Status

codecov-io commented 4 years ago

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #106   +/-   ##
=======================================
  Coverage   52.99%   52.99%           
=======================================
  Files          78       78           
  Lines        1970     1970           
=======================================
  Hits         1044     1044           
  Misses        926      926
Impacted Files Coverage Δ
src/XCFunctional.cpp 65.65% <ø> (ø) :arrow_up:
src/config.hpp 0% <ø> (ø) :arrow_up:
tests/testall.cpp 91.97% <ø> (ø)

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 630fdee...6d7fd7d. Read the comment docs.

bast commented 4 years ago

@bast I think the documentation on dftlibs.org is completely outdated and can be safely decommissioned.

I will take care of that one.

robertodr commented 4 years ago

@bast I think the documentation on dftlibs.org is completely outdated and can be safely decommissioned.

I will take care of that one.

Maybe we can set up a redirect to readthedocs?

bast commented 4 years ago

@bast I think the documentation on dftlibs.org is completely outdated and can be safely decommissioned.

I will take care of that one.

Maybe we can set up a redirect to readthedocs?

Redirect is now in place: https://dftlibs.org