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

Only build api docs if -Ddocumentation=true #133

Closed
wants to merge 1 commit into from

Conversation

heirecka
Copy link
Contributor

This matches the behaviour of the cmake build system.
Also search for gtk-doc, which is required to build the api docs and
better fail early than later during make install.

This matches the behaviour of the cmake build system.
Also search for gtk-doc, which is required to build the api docs and
better fail early than later during make install.
@heirecka
Copy link
Contributor Author

Couldn't really test with -Ddocumentation=true because publican isn't packaged here (yet).

@ximion
Copy link
Owner

ximion commented Aug 31, 2017

I think that the API documentation was always built, precisely because a gtk-doc dependency is easier to satisfy for distros than a dependency on Publican.

@ximion
Copy link
Owner

ximion commented Aug 31, 2017

Okay, looking at the CMake things: The API docs were not rebuilt without the -DDOCUMENTATION=ON flag, but the prebuilt API docs were installed. With Meson, there is no prebuilt API documentation anymore, only a prebuilt copy of the spec, for those people who do not have Publican.

I do want the API docs to be present, if I hide them behind the documentation flag, distros will just not ship them (or forget to ship them), which is not ideal.
I'll need to think about it.

Just out of interest, does your distro have MkDocs1?

@heirecka
Copy link
Contributor Author

I do want the API docs to be present, if I hide them behind the documentation flag, distros will just not ship them (or forget to ship them), which is not ideal.
I'll need to think about it.

Sure.

Just out of interest, does your distro have MkDocs1?

No, but that does at least not hide its tarballs behind a bunch of broken links.

@ximion ximion closed this in 8e0abb1 Sep 3, 2017
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

Successfully merging this pull request may close these issues.

None yet

2 participants