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

Add documentation for the public API #37

Open
aperezdc opened this issue Nov 22, 2018 · 7 comments
Open

Add documentation for the public API #37

aperezdc opened this issue Nov 22, 2018 · 7 comments

Comments

@aperezdc
Copy link
Contributor

aperezdc commented Nov 22, 2018

As of #41 we have HotDoc wired to the build system, but writing actual documentation is still pending. So let's keep this issue open until we have a good the API reference documentation in place 😉

The original description of the issue follows, for reference.


Probably we would want to use GTK-Doc, which despite the name does not need GTK+ at all. That would allow cross-linking to the WPE WebKit API reference if needed.

Side note: there is an upstream bug to add GTK-Doc support to WPE WebKit as well.

@zdobersek
Copy link
Contributor

@aperezdc wdyt about hotdoc?
https://hotdoc.github.io/index.html

@aperezdc
Copy link
Contributor Author

aperezdc commented Jan 3, 2019

HotDoc looks nice, indeed!

@thiblahute
Copy link
Contributor

If you decide to go with hotdoc I can help get started (or even do it if you do not have time, it should probably not be much time at all to do!)

@aperezdc
Copy link
Contributor Author

aperezdc commented Jan 5, 2019

@thiblahute If you would be so kind to open a PR with the needed bits to get HotDoc running that would be great. No need to write all the docs, a stub is fine and we can write the actual documentation as follow-ups.

@thiblahute
Copy link
Contributor

thiblahute commented Jan 6, 2019

getting #9 in before would make the integration simpler, wdyt?

EDIT: It is so simple that we do not care.

@aperezdc
Copy link
Contributor Author

aperezdc commented Jan 7, 2019

While I would like using Meson, at the same time I would rather not maintain two different build systems. While Buildroot has now support for Meson, people are still using older versions which do not include it, and I am not sure what's the situation with other build systems (e.g. Yocto). For the moment it seems like sticking with CMake would be best, so let's review #41 as-is (thanks for sending the PR!).

@aperezdc
Copy link
Contributor Author

PR #81 adds automatic deployment of built documentation to GitHub pages.

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

No branches or pull requests

3 participants