Added support for an alternative current dir mode in pkldoc #824
Conversation
| The directory where generated documentation is placed. | ||
| ==== | ||
|
|
||
| .--current-directory-mode |
There was a problem hiding this comment.
Unless you foresee a third mode, a flag would be easier to use and understand.
There was a problem hiding this comment.
Yes, I think that it might be possible to eventually have a mode to disable current generation at all.
Also, I'm not very sure about a binary flag to be easier to understand to be honest. It is not disabling or enabling something here, it is changing the logic of operation between two states. Enums are supposed to be the tool for this (one of discussions).
There was a problem hiding this comment.
I agree with @translatenix here; I think this should be called --no-symlinks, and default to false. It's not necessarily about how the "current" dir is treated; the intention is to disable symlinks.
There was a problem hiding this comment.
That's a good point that I had failed to notice.
netvl
force-pushed
the
current-publishing-variants
branch
from
2eca683 to
3af4b39
Compare
Some systems, for example, GitHub Pages, have trouble with handling symlinks, which breaks the
currentdirectory links created by Pkldoc. In this PR, we add an alternative mode which creates a full copy of the latest published version contents in thecurrentdirectory instead.