Doc installation #901
Doc installation #901
Conversation
Co-authored-by: Owen Parkins <[email protected]>
Co-authored-by: Mengna Li <[email protected]>
|
@henryiii did we want to reduce the installation section of the readme and include some of the stuff that is in that section in the docbook? |
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## main #901 +/- ##
=======================================
Coverage 99.46% 99.46%
=======================================
Files 18 18
Lines 4099 4099
=======================================
Hits 4077 4077
Misses 22 22 ☔ View full report in Codecov by Sentry. |
|
We can, we could just show the main way + list the others shown in the gitbook. FYI, I'm going to need to migrate off of GitBook in the near future, it's pretty well past EoL. Maybe a JupyterBook, or a Hugo/jekell/sphinx/mkdocs solution would work, not sure yet what would be best. |
|
we use sphinx and readthedocs in most of my other projects. That handles markdown, though I would imagine any changes would require some level of restructuring. |
github-actions
bot
added
the
needs changelog
| FetchContent_MakeAvailable(cli11) | ||
|
|
||
| # And now you can use it | ||
| add_subdirectory(${cli11_proj_SOURCE_DIR} ${cli11_proj_SOURCE_DIR}/build) |
There was a problem hiding this comment.
Is there any reason the additional add_subdirectory call and the SOURCE_DIR parameter have been added here compared to the more idiomatic version that was in the readme before?
The second one just bit me on a CI system with caching for the default FetchContent directories set up.
I can prepare a small PR but I wanted to ask first since it looks like it has been deliberately changed.
This PR includes updates from #774 and #613.
It updates the readme and docbook with some additional installation instructions.