[ docs ] Build IdrisDoc in a namespace. #2826
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When invoking `idris2 --mkdocs foobar.ipkg`, the current behaviour is for the compiler to dump the documentation in `${builddir}/docs`.
The location `${builddir}/docs` is used regardless of the package name.
Thus for projects that present multiple packages the `docs` build directory will become polluted and corrupt if the developer is not careful.
This one change ensures that for package `x` the documentation is generated in the directory: `${builddir}/docs/x`.
Idris2 `Makefile` has been updated to reflect the change.
|
IIUC this will require us to update the CI script that generates the docs automatically: Idris2/.github/scripts/katla.sh Line 23 in 45fc038 Something like: - cp -r "$prefix"/"$libname"/build/docs/* html/"$libname"
+ cp -r "$prefix"/"$libname"/build/docs/"$libname"/* html/"$libname" |
|
Ah good catch! I thought I had updated everything that used the docs. |
|
I will leave this open until Tuesday, when I will merge it. |
|
I don't know what to think. On the one hand it allows you to know the output you're looking at Basically: why is this necessary for |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When invoking
idris2 --mkdocs foobar.ipkg, the current behaviour is for the compiler to dump the documentation in${builddir}/docs. The location${builddir}/docsis used regardless of the package name. Thus for projects that present multiple packages thedocsbuild directory will become polluted and corrupt if the developer is not careful. This one change ensures that for packagexthe documentation is generated in the directory:${builddir}/docs/x.Idris2
Makefilehas been updated to reflect the change.Should this change go in the CHANGELOG?
CHANGELOG.md(and potentially alsoCONTRIBUTORS.md).