manual: docitem macros for linking modules #9988
Conversation
|
This could be rebased now that #9987 is merged. |
Octachron
force-pushed
the
manual_docitem_macros
branch
from
84b13ec
to
669623c
Compare
manual/manual/library/libunix.etex
Outdated
|
|
||
| \section{s:Module \texttt{UnixLabels}: labelized version of the interface} | ||
| \section{Module \texttt{UnixLabels}: labelized version of the interface} |
There was a problem hiding this comment.
the s: looks like a search-and-replace bug here, right? But how come we are not using the new \section{label}{title} macro?
There was a problem hiding this comment.
I don't remember how I inserted this s: here.
Part of the issue is that this section heading is the only one in the manual that is inside an ocamldocinput section, which reinstall the normal section macro.
I have pushed a change to get out earlier of the ocamldocinput mode and avoid this corner case.
There was a problem hiding this comment.
In the new patch, the label is Unixlabels when I would maybe have expected s:Unixlabels, but I trust you to have done the right thing.
There was a problem hiding this comment.
I have merely kept the previous label since the label is unused, not in conflict with other labels, and only exists in the pure latex version of the manual.
There was a problem hiding this comment.
This looks like a nice simplification/improvement to me. I have not tested the build, but I trust @Octachron to do it.
Currently adding a new module to the manual documentation requires to update between two and three locations.
This PR build upon #9987 to eliminate one of those locations by defining unified macros for linking module from the html or latex side.
Those new macros are also useful when using alternative documentation generators that have different naming conventions for documentation files.
Along the way, I have updated the standard library module documentation test. It should now be able to detect incomplete updates of the documentation.