Update hyperlinks in documentation#2495
Conversation
|
@felixhekhorn I decided to also fix the equation references in https://docs.nnpdf.science/theory/PTevol.html so in the end it will still take some time |
|
wait a moment: I suggest to drop that page as is and instead point to https://eko.readthedocs.io, where all of this is already explained in great detail @scarlehoff do you agree? |
|
cc #2288 |
|
It's the information exactly the same? If yes, ok from me. |
|
@felixhekhorn Ah ok, I had not seen that in #2288 this stuff is already being done. Shall I check if the info is the same & drop it if yes, or leave it to #2288? |
all the evolution information is covered by EKO - and actually this page here is severely outdated, e.g. it does not discuss QED, that we use exact these days, or SV scheme B, so better we drop it. And yes, @evagroenendijk please drop it here and then tick off the relevant box over there Instead, TMC - which has nothing to do with evolution - should point to https://yadism.readthedocs.io/en/latest/implementation/TMC.html ... aaand then that page is empty, but then we should fix that there, where it belongs. The current content can not be simply transferred since it uses Mellin space (which yadism is not doing). Also the implementation in yadism is more complex as we allow, e.g., different levels (/orders) if TMC. Note that the code documentation does have some explanation ... Any way, don't forget the main purpose of this PR 🙃 |
felixhekhorn
left a comment
felixhekhorn
left a comment
There was a problem hiding this comment.
As I already said: updating the documentation is nice and good - but was not the intended task for this PR
| ------------- | ||
|
|
||
| `APFEL <https://apfel.hepforge.org/>`_ ('A PDF Evolution Library') is the PDF evolution code currently | ||
| `APFEL <https://github.com/scarrazza/apfel>`_ ('A PDF Evolution Library') is the PDF evolution code currently |
There was a problem hiding this comment.
"currently used"? definitely not. Note that "Note that at the time of writing ..." has passed 🙃 -> replace with EKO. It can be a very short paragraph in my opinion, because EKO has it's detailed documentation. Drop APFEL as a whole. HOPPET can stay in the light of #2485 under "Other codes", though the content should also be cut down to the bare minimum such that it does not specify outdated information (e.g. by now HOPPET can also do N3LO)
There was a problem hiding this comment.
I would drop the file as a whole - and if you wish to keep the entry in the menu, which maybe is fine, point it directly to the EKO documentation.
TMC has nothing to do with evolution and in fact now that DIS is becoming less prominent, it only applies to this very specific set of observables
| @@ -42,7 +42,7 @@ the subset that most truthfully reproduces the underlying probability distributi | |||
| Other codes | |||
There was a problem hiding this comment.
the pineline should be featured prominently here (again with a (very) short paragraph pointing to the relevant documentation https://nnpdf.github.io/pineline )
Sure! That's why I did not look at the text, I just updated the links. Actually as far as the nnpdf documentation goes, I pushed all the changes I made already (I did not find any other deprecated links) |
ehm, actually, looking at 28ae19b let me ask to be sure: is it clear what #572 wants to do? Specifically, we are not talking about any explicitly written URL in our documentation (like the ones you change in that commit) - we are talking about the automatic link generated by sphinx
(maybe this indicates we are not talking about the same thing 🙈 ) |
Ah okay, then indeed I misunderstood the issue... |
|
@felixhekhorn I think I can use this https://www.sphinx-doc.org/en/master/usage/extensions/linkcode.html then to solve the issue, would you agree? It can then point to the n3fit and validphys directories in the repository |
not sure - this is the right direction, but then you would need to provide the mapping between name of "the thing" (function, class) and the URL yourself. I hope there are better solutions out there, which are already targeted at GitHub and do all the magic for you |
3 participants
No description provided.