jscaux
/
ABACUS-v1
3
0
Fork 0
Code Issues 1 Pull Requests Releases Wiki Activity

Activate the Doxygen documentation

This commit is contained in:
J.-S. Caux 2018-02-11 19:01:20 +01:00
parent 0559fa9301
commit c95a3e53df
4 changed files with 2506 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2492
ABACUS_Doxyfile Normal file
View File

File diff suppressed because it is too large Load Diff

9
Makefile
View File

@ -476,7 +476,16 @@ parallel :
###########################################
# Cleanup
.PHONY: clean
clean :
/bin/rm -f $(Objects_ALL)
/bin/rm -f $(LIBDIR)$(VERSION)
/bin/rm -f $(EXECS)
###########################################
# Documentation
.PHONY: docs
docs :
doxygen ABACUS_Doxyfile && make -C docs/latex

3
README.md
View File

@ -25,6 +25,9 @@ $ make
```
This will produce all executables, together with a library `ABACUS_[vn]` where vn is of the form [digit][character].
## Documentation
Documentation for the ABACUS codebase is generated using Doxygen. To generate the documentation, invoke `make docs` (you will need to have Doxygen installed on your system). The configuration file is `ABACUS_Doxygen`. The HTML version is anchored at `docs/html/index.html`. The PDF version is located at `docs/latex/refman.pdf`.
## Warnings
* The ODSLF part (for one-dimensional spinless fermions) is not functional: it is based on the old Young Tableaux ids, and must be upgraded to `State_Label`s.
* The Richardson part is not implemented; what exists is old and long deprecated.

2
docs/.gitignore vendored Normal file
View File

@ -0,0 +1,2 @@
*
!.gitignore