Add sphinx docs #193
Add sphinx docs #193
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #193 +/- ##
===========================================
+ Coverage 83.39% 83.42% +0.03%
===========================================
Files 54 54
Lines 19385 19385
Branches 1852 1852
===========================================
+ Hits 16166 16172 +6
+ Misses 3219 3213 -6
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Remove :private-members: Co-authored-by: Philipp Basler <[email protected]>
|
I think BSMPT deserves a logo, I put just a placeholder on the sphinx documentation. We are accepting suggestions. |
There was a problem hiding this comment.
Yes, I am planning on creating a few examples to show the very basics on how to use the code.
There was a problem hiding this comment.
As a general remark for these executable files: Should we maybe also list the examples in the example folder and the command on how to create them?
I think it would be nice here
| .. BSMPT - Beyond the Standard Model Phase Transitions documentation master file, created by | ||
| sphinx-quickstart on Wed Dec 11 17:49:02 2024. | ||
| You can adapt this file completely to your liking, but it should at least | ||
| contain the root `toctree` directive. |
There was a problem hiding this comment.
| .. BSMPT - Beyond the Standard Model Phase Transitions documentation master file, created by | |
| sphinx-quickstart on Wed Dec 11 17:49:02 2024. | |
| You can adapt this file completely to your liking, but it should at least | |
| contain the root `toctree` directive. |
|
|
||
| On the scalar sector there are two doublets | ||
|
|
||
| .. math:: |
There was a problem hiding this comment.
Is it possible to use the doxygen math here? Just to not have to type this twice for future models.
But not really a problem if it does not work
No description provided.