Catch2
Catch2 copied to clipboard
[Add Feature] View docs in a more comfortable way
Description
When I'm reading the documentation, I felt a bit uncomfortable when traveling between files. So I think I can change that by using a static website generator. In this case, I pick vitepress, which is a framework that specifies with writing documentation on various Github Projects.
You can see the final work on : https://ryankert01.github.io/Catch2/
I think it is pretty nice with the look and the experience and can potentially attract more users.
Codecov Report
Merging #2478 (ec98362) into devel (4adf010) will increase coverage by
0.01%
. The diff coverage isn/a
.
@@ Coverage Diff @@
## devel #2478 +/- ##
==========================================
+ Coverage 91.54% 91.55% +0.01%
==========================================
Files 183 183
Lines 7561 7561
==========================================
+ Hits 6921 6922 +1
+ Misses 640 639 -1
I think you may want to update the .gitignore
!
e.g. docs/dist/
and node_modules
updated that
Nice, don't forget to remove the files currently committed in those locations. That should remove around 1million lines from this pull request!
deleted node_modules and docs/.vitepress/dist
There is also #2672 competing for this, and I believe sphinx is more standard. Want to discuss this in #2709 ?