Conversation
Author
|
The advantage of this PR is that you can take cmake/FindSphinx and doc/ as they are and plug them into a new project that uses the standard "src/" and "include/" top folders, it works from the start, with no additional modification (it did on one of my project at least) |
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
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.
First, thanks a lot for your article and for this repo. It helps a lot!
I made some simple modifications to your projet, in order to make it easier to use in the case of a standard project that would use a top "src" + "include" folder and demonstrate a use case with several targets.
This version should be compatible with the merged or not merged header project layout conventions, since it searches for headers in both folders (except src//internal src//details and src/**/private)
I do not think this version would be compatible with your article, so I do not think it should be merged into master. However - and if you are interested - may be you could add a branch with this version.
The resulting doc on readthedocs:
https://pthom-cpp-documentation-example.readthedocs.io/en/latest/