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

Documentation: adding entire directory structure to doxygen #86

Open
aniabrown opened this issue Jan 8, 2019 · 3 comments
Open

Documentation: adding entire directory structure to doxygen #86

aniabrown opened this issue Jan 8, 2019 · 3 comments

Comments

@aniabrown
Copy link
Collaborator

It looks like the CPU and GPU folders need to be added to the doxygen config as these files are not currently showing up

@aniabrown
Copy link
Collaborator Author

I updated the doxyconf file to include files in those directories in f5cf4a5. However, I couldn't find a way for the directory structure to be kept in the list of files in https://quest-kit.github.io/QuEST/files.html. Also, where there are multiple implementations of a function, the source code of the serial cpu implementation will be the one linked from header files etc -- we may consider generating a different version of the documentation for each architectures (would only be useful for developers).

@TysonRayJones
Copy link
Member

Should we avoid making these changes on master? I worry it could break the doc on https://quest.qtechtheory.org/docs/ which has links to Doxygen keys.
Note there are no public-facing functions in the backend, so this doesn't expose more doc to a user.

Note also (as mentioned on the 18th) there's some problem with the repo, where pull requests are cloning all 200 of previous commits - master is already ahead of dev! We should fix this asap before making any more big commits, especially to master.

@aniabrown
Copy link
Collaborator Author

Looks like the links are still working as I only made changes to the file list page, which as far as I can tell isn't referenced in https://quest.qtechtheory.org/docs/. I take your point though -- I'm happy to do updates to files outside the QuEST library directory on the develop branch as well from now on. (Let me know if you're still worried about this one and I can revert it as well).

Will look into the pull request issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants