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 docs on readthedocs.org #20

Closed
dfellis opened this issue Jan 26, 2018 · 3 comments
Closed

Doxygen docs on readthedocs.org #20

dfellis opened this issue Jan 26, 2018 · 3 comments

Comments

@dfellis
Copy link
Collaborator

dfellis commented Jan 26, 2018

I'm making this an issue because I'm not sure if there's some other mechanism Uber plans to host documentation for OSS projects, but it seems reasonable to me for the h3 docs to be on readthedocs.org

Here's the official getting started page and here's a stackoverflow answer on how to integrate with doxygen

I will also note that readthedocs needs an account set up, so it probably would have to be someone at Uber to do this, but I can help review things if you decide to go with it.

@isaacbrodsky
Copy link
Collaborator

We should definitely get a hosted copy of the built documentation. I'm also thinking about getting Github Pages setup. That doesn't have the same nice publishing tooling, but may be easier as we expand the documentation.

@isaacbrodsky
Copy link
Collaborator

Docs are now live on https://uber.github.io/h3/ The source can be found in the website directory in the repo. Pull requests are of course welcome!

@dfellis
Copy link
Collaborator Author

dfellis commented Mar 13, 2018

Awesome news! :)

@dfellis dfellis closed this as completed Mar 13, 2018
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