Browse Source

Activate the Doxygen documentation

master
J.-S. Caux 6 years ago
parent
commit
c95a3e53df
4 changed files with 2506 additions and 0 deletions
  1. 2492
    0
      ABACUS_Doxyfile
  2. 9
    0
      Makefile
  3. 3
    0
      README.md
  4. 2
    0
      docs/.gitignore

+ 2492
- 0
ABACUS_Doxyfile
File diff suppressed because it is too large
View File


+ 9
- 0
Makefile View File

@@ -476,7 +476,16 @@ parallel :
476 476
 ###########################################
477 477
 # Cleanup
478 478
 
479
+.PHONY: clean
479 480
 clean :
480 481
 	/bin/rm -f $(Objects_ALL)
481 482
 	/bin/rm -f $(LIBDIR)$(VERSION)
482 483
 	/bin/rm -f $(EXECS)
484
+
485
+
486
+###########################################
487
+# Documentation
488
+
489
+.PHONY: docs
490
+docs :
491
+	doxygen ABACUS_Doxyfile && make -C docs/latex

+ 3
- 0
README.md View File

@@ -25,6 +25,9 @@ $ make
25 25
 ```
26 26
 This will produce all executables, together with a library `ABACUS_[vn]` where vn is of the form [digit][character].
27 27
 
28
+## Documentation
29
+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`. 
30
+
28 31
 ## Warnings
29 32
 * 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.
30 33
 * The Richardson part is not implemented; what exists is old and long deprecated.

+ 2
- 0
docs/.gitignore View File

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

Loading…
Cancel
Save