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

Complete documentation and build doc website #29

Open
jacobpwagner opened this issue Jan 9, 2020 · 0 comments
Open

Complete documentation and build doc website #29

jacobpwagner opened this issue Jan 9, 2020 · 0 comments

Comments

@jacobpwagner
Copy link
Member

It would be helpful to have a website with a doc/API reference page for cytolib similar to the other cytoverse packages. For example, see the flowWorkspace site. This will require:

  1. Completing the documentation in the form of Doxygen-compliant docstrings to enable easy building of corresponding HTML.
  2. Weaving the generated documentation HTML in to a nicely formatted website. Again, Doxygen will make this much easier, but if we would like a similar format to the other doc websites we may be able to leverage pkgdown after the the doc HTML files are generated.

The first point is by far the more time consuming, but will pay off in the long run in terms of maintenance of the code base.

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

1 participant