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

creating ./docs folder while compiling docs #631

Merged
merged 1 commit into from
Jul 24, 2018

Conversation

theGreatWhiteShark
Copy link
Contributor

As described in issue #630 the generation of the documentation using Doxygen via the build script ./build.sh d was not working. The problem was located in build/CMakeFiles/doc.dir/build.make line 58 where the CMakeFiles/doc target tries to enter the ./docs folder at the root directory of the repository. Since this folder is not created by either the build script or CMake the generation of the documentation fails.

To solve this issue I introduced a line in the ./CMakeList.txt file creating the missing ./docs/ folder.

@jeremyz
Copy link
Member

jeremyz commented Jul 23, 2018

Hi @theGreatWhiteShark !
I would create the directory in ${CMAKE_CURRENT_BINARY_DIR}/doc.
and to do so I would use :
add_custom_target(doc_dir ALL COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_CURRENT_BINARY_DIR}/doc)
then add DEPENDS doc_dir to the doc target.
so that the directory is always created at build time and not only at configure time.

The generation of the documentation using Doxygen using the build script `./build.sh d` was not working. The problem was located in *build/CMakeFiles/doc.dir/build.make* line 58 where the `CMakeFiles/doc` target tries to enter the *./docs* folder at the root directory of the repository. Since this folder is not created by either the build script or CMake the generation of the documentation fails.

    To solve this issue I introduced a line in the *./CMakeList.txt* file creating the missing *./docs/* folder.
@theGreatWhiteShark
Copy link
Contributor Author

Ah, very nice.

I actually intended to implement it just like this. But since I'm not an expert in cmake I tried to add the -E make_directory option to the doc target itself and couldn't get it running.

Thanks!

@jeremyz
Copy link
Member

jeremyz commented Jul 24, 2018

cmake is a dirty bitch a would say (make_directory beeing deprecated for ages with no known alternative(that I know about)),
but as the guy who brought it to hydrogen, I should just shut my mouth ;)
I'll merge your patch and remove the then useless file(MAKE_DIRECTORY ...
and will alos change CMAKE_CURRENT_SOURCE_DIRto CMAKE_CURRENT_BINARY_DIR.

btw, I can't wait to find the time needed to review #627,
greetings to you @theGreatWhiteShark !

@jeremyz jeremyz merged commit fec1a93 into hydrogen-music:master Jul 24, 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

Successfully merging this pull request may close these issues.

2 participants