Conversation
Writing docs in markdown has long been discouraged and supporting it has some costs in terms of tooling, as it requires less tested and developed extensions to sphnx that constitute extra dependencies. Convert exiting files to rst so we can remove markdown processing altogether.
scarlehoff
left a comment
There was a problem hiding this comment.
Thanks for this!
I think I did go through all the files that changed (in the browser, not the source) and I've flagged all the problems I've seen.
| [NC] SIA normalized top cross section (electron-proton) - | ||
| SIA_NORM_XSEC_NF4: [NC] SIA normalized total cross section (nf=4) | ||
| (electron-proton) - SIA_NORM_XSEC: [NC] SIA normalized total cross | ||
| section (electron-proton) |
There was a problem hiding this comment.
The conversion has not quite worked for this list (adding \n before every - should suffice I guess?)
| C-factor scaling, copies ``COMPOUND`` files, deletes the subgrids, and | ||
| finally compresses the result into a theory.tgz file ready for upload. - | ||
| ``results/upload_theories`` automatically upload to the server all the | ||
| theory.tgz files that have been generated. |
There was a problem hiding this comment.
It seems to be in general for this file at least that the lists have not been parsed correctly.
| Hardware: - Intel(R) Core(TM) i7-6700 CPU @ 4.00GHz - 16 GB RAM 3000 MHz | ||
| DDR4 | ||
|
|
||
| Timing for a fit: - Walltime: 397s - CPUtime: 1729s |
| selectively for specific datasets. To do that, add their names to a list | ||
| called ``do_not_require_similarity_for``. The datasets in the list do | ||
| not need to appear in the ``cuts_intersection_spec`` namespace and will | ||
| be filtered according to the internal cuts unconditionally. |
Change now erroneous references to markdown to rst. Prefer removing file extensions from references. Prefer references to links where noticed, adding the corresponding labels. Remove nested markup, particularly inside links, as that is not supported by rst (which makes the output worse, but alternatives don't seem worth it, see https://docutils.sourceforge.io/FAQ.html#is-nested-inline-markup-possible ).
Co-authored-by: Juan M. Cruz-Martinez <juacrumar@lairen.eu> Remove various warnings reported by Shpinx. Fix incorrect conversion of markdown lists to rst wherever encountered.
| convergence/stability in the fit. To read more about this, see `How to | ||
| run an iterated fit <run-iterated-fit>`__. |
There was a problem hiding this comment.
| convergence/stability in the fit. To read more about this, see `How to | |
| run an iterated fit <run-iterated-fit>`__. | |
| convergence/stability in the fit. To read more about this, see :ref:`How to | |
| run an iterated fit <run-iterated-fit>`. |
I think internal links should be like this instead?
There was a problem hiding this comment.
There are a few more than that one (sorry, it wasn't clear)
There was a problem hiding this comment.
uh I see this is creating a lot of broken links :(
Co-authored-by: Juan M. Cruz-Martinez <juacrumar@lairen.eu>
|
Are you waiting for me to do #1598 before? |
|
I guess https://github.com/NNPDF/nnpdf/blob/master/doc/README.md should also be updated? |
50cd35c to
64befe2
Compare
|
AFAICT I had started finding and fixing broken links. I think there were a few (also in rst). |
|
FWIW a subset of the "broken" stuff below is indeed broken. I think the first few are introduced by incorrect conversion to rst. Details~/n/n/d/sphinx (nomddocs %) $ sphinx-build source/ build/ -b linkcheck |
Having markdown required more tooling and more documentation and it is not worth it as it ends up being full of
eval_rstclauses.Convert the existing files to markdown and remove the tooling for it.
One problem is that rst has for some reason no obvious way of having markup inside the links, which is something markdown doesn't know about and needs to be cleaned by hand. Also we had explicit references to markdown source files in varios places. Overall there is quite a big chance of things being missed or getting ugly, even though I tried to remove mos of the warnings.