Add possibility to disable doc build for Fedora by external macro#170
Open
dsilakov wants to merge 4 commits intofedora-python:mainfrom
Open
Add possibility to disable doc build for Fedora by external macro#170dsilakov wants to merge 4 commits intofedora-python:mainfrom
dsilakov wants to merge 4 commits intofedora-python:mainfrom
Conversation
Member
|
hroncok
reviewed
Jun 5, 2018
| %if 0%{?_without_doc} | ||
| %bcond_with doc | ||
| %else | ||
| %bcond_without doc |
Member
There was a problem hiding this comment.
just keep this line; the if/else part is not needed at all.
Member
|
Now should it be doc or docs? |
Author
|
Not sure if Fedora has formalized policy on this. I kept in mind OpenStack specs from RDO, many of them use "doc" and none uses "docs" |
|
Hello! Do you accept a pull request that adds a "- without_doc" file that disables the documentation build? This is just an option. By default, pyp2rpm will also compile with documentation. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Sometimes it is convenient to disable generation of documentation for python modules. A common practice is to use "doc_guard" for this - enclose doc-related parts with
%if 0%{?with_doc}condition (see e.g., redhat-openstack/easyfix#6).Default value for with_doc macro is set to 1; this patch also takes into account global _without_doc macro, so one can turn documentation on/off by changing a single macro in a build environment.