Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doxygen documentation generator from sources for OpenFHE #738

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

arcturusannamalai
Copy link

@arcturusannamalai arcturusannamalai commented Apr 16, 2024

Add Doxygen for source browsing and implementation docs

To install Doxygen and Graphviz on Linux/Ubuntu you may run,

$ sudo apt-get install doxygen 
$ sudo apt-get install graphviz

To run and generate the docs you can run,

$ doxygen OpenFHE.Doxygen

which will populate the HTML in the 'html' folder.

To view the documentation,

$ cd html && python3 -m http.server 

you will be able to see the docs in the browser

@yspolyakov yspolyakov added the documentation Improvements or additions to documentation label Apr 19, 2024
@yspolyakov yspolyakov added this to the Release 1.2.0 milestone Apr 19, 2024
@yspolyakov yspolyakov marked this pull request as draft April 19, 2024 21:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants