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.

Sign up for GitHub

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

Jump to bottom

cmake: Add docs build target #165

Merged
merged 1 commit into from
May 1, 2024
Merged

cmake: Add docs build target #165

merged 1 commit into from
May 1, 2024

Conversation

hebasto
Copy link
Owner

@hebasto hebasto commented Apr 23, 2024

Same as make docs in the master branch.

@hebasto hebasto added the enhancement New feature or request label Apr 23, 2024
@hebasto hebasto mentioned this pull request Apr 24, 2024
Closed
vasild
vasild reviewed Apr 24, 2024
View reviewed changes
doc/Doxyfile.in Outdated
@@ -58,7 +58,7 @@ PROJECT_LOGO = doc/bitcoin_logo_doxygen.png
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.

OUTPUT_DIRECTORY = doc/doxygen
OUTPUT_DIRECTORY = @PROJECT_BINARY_DIR@/doxygen
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(feel free to ignore)

I find it more intuitive to put the generated documentation in the doc subdirectory:

Suggested change
OUTPUT_DIRECTORY = @PROJECT_BINARY_DIR@/doxygen
OUTPUT_DIRECTORY = @PROJECT_BINARY_DIR@/doc/doxygen

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found a shorter path more convenient.

Not sure which approach is the optimal, though.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Me neither. I guess that there are the following options:

  1. OUTPUT_DIRECTORY = @PROJECT_BINARY_DIR@/doxygen (as in this PR currently, differs from master). Would generate the docs in BUILD/doxygen/html/index.html but put some supplementary files in BUILD/doc/.

  2. OUTPUT_DIRECTORY = @PROJECT_BINARY_DIR@/doc/doxygen (as in master currently). Everything doc-related goes into BUILD/doc/ with the generated docs at BUILD/doc/doxygen/html/index.html.

  3. OUTPUT_DIRECTORY = @PROJECT_BINARY_DIR@/doc. Everything doc-related goes into BUILD/doc/ with the generated docs at BUILD/doc/html/index.html.

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

2. `OUTPUT_DIRECTORY = @PROJECT_BINARY_DIR@/doc/doxygen` (as in `master` currently). Everything doc-related goes into `BUILD/doc/` with the generated docs at `BUILD/doc/doxygen/html/index.html`.

The option 2 has been chosen during the recent call.

doc/CMakeLists.txt Outdated Show resolved Hide resolved
doc/CMakeLists.txt Show resolved Hide resolved
@hebasto
Copy link
Owner Author

hebasto commented Apr 27, 2024

Addressed @vasild's comments.

@hebasto
Copy link
Owner Author

hebasto commented Apr 30, 2024

Rebased.

vasild
vasild approved these changes May 1, 2024
View reviewed changes
Copy link

@vasild vasild left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK d88e03c

Tested and it works as expected. Thanks!

@hebasto hebasto merged commit 9972e39 into cmake-staging May 1, 2024
28 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vasild vasild vasild approved these changes

Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@hebasto @vasild