Update container image to build libs documentation. #22
Conversation
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
giomba
force-pushed
the
giomba/build-libs-docs-in-container
branch
from
0240dae to
c77311f
Compare
Contributor
|
Is the documentation mandatory to build the emulator? |
Collaborator
Author
No, it is useful only for development. |
giuliof
requested changes
Jun 19, 2025
CMakeLists.txt
Outdated
|
|
||
| include_directories(vendor/Z80/API) | ||
| set(Z80_SHARED_LIBS NO CACHE BOOL "") | ||
| set(Z80_WITH_HTML_DOCUMENTATION YES) |
Contributor
There was a problem hiding this comment.
To avoid the documentation to be built by default, I suggest to not set this and to add in the documentation to use -DZ80_WITH_HTML_DOCUMENTATION=True in configuration to optionally build it.
Collaborator
Author
There was a problem hiding this comment.
I preferred not to have to remember which particular -D flag I had to pass to the build in order to build the documentation, and make it all automagic, but I can still see your point. Ok, I'll just remove it.
giomba
force-pushed
the
giomba/build-libs-docs-in-container
branch
from
c77311f to
83bd443
Compare
giuliof
approved these changes
Jun 21, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I think that the title is self-explanatory.
I moved the set(Z80...) variable before the include of the library, because it is needed to build the docs.
This changes the previous behaviour (docs are always built, instead of only being built when building in debug mode, and the build output is very verbose), but this doesn't look like a big issues, since CMake is smart enough to only build it the first time.