Skip to content

cmake: Add docs build target#165

Merged
hebasto merged 1 commit into
cmake-stagingfrom
240423-cmake-DZ
May 1, 2024
Merged

cmake: Add docs build target#165
hebasto merged 1 commit into
cmake-stagingfrom
240423-cmake-DZ

Conversation

@hebasto
Copy link
Copy Markdown
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
Comment thread doc/Doxyfile.in Outdated
# left blank the current directory will be used.

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

@vasild vasild Apr 24, 2024

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
Copy Markdown
Owner Author

@hebasto hebasto Apr 24, 2024

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
Copy Markdown

@vasild vasild Apr 25, 2024

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
Copy Markdown
Owner Author

@hebasto hebasto Apr 27, 2024

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.

Comment thread doc/CMakeLists.txt Outdated
Comment thread doc/CMakeLists.txt
@hebasto
Copy link
Copy Markdown
Owner Author

hebasto commented Apr 27, 2024

Addressed @vasild's comments.

@hebasto
Copy link
Copy Markdown
Owner Author

hebasto commented Apr 30, 2024

Rebased.

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

@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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@vasild vasild vasild approved these changes

Reviewers whose approvals may not affect merge requirements

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