Commit d45d05ca authored Jun 23, 2020 by Mccaskey, Alex

adding doxygen setup



Signed-off-by: Alex McCaskey <mccaskeyaj@ornl.gov>

parent 633d0551

README.md

+6 −0

Original line number	Diff line number	Diff line
		@@ -9,6 +9,12 @@
		QCOR is a C++ language extension and associated compiler implementation
		for hybrid quantum-classical programming.


		Documentation
		-------------

		* [API Documentation](https://ornl-qci.github.io/qcor-api-docs/)

		Quick Start
		-----------
		QCOR nightly docker images are available that serve up an Eclipse Theia IDE (the same IDE Gitpod uses) on port 3000. To get started, run

docs/doxygen/Doxyfile.cmake

0 → 100644

+2515 −0

File added.

Preview size limit exceeded, changes collapsed.

docs/doxygen/README.md

0 → 100644

+4 −0

Original line number	Diff line number	Diff line
		Note the current workflow for generating qcor api documentation is completely manual.

		from this directory run `doxygen Doxyfile.cmake`, and copy the contents of
		the html folder into the qcor-api-docs repository docs folder.
		No newline at end of file