-
Notifications
You must be signed in to change notification settings - Fork 22
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
force version 1.0 of Documenter.jl #953
force version 1.0 of Documenter.jl #953
Conversation
(as in AbstractAlgebra.jl and Nemo.jl) For that, I have changed the three cross-references to the JuliaInterface manual from relative (pointing to `../assets/html/JuliaInterface/chap0_mj.html`) to absolute (pointing to `https://oscar-system.github.io/GAP.jl/stable/assets/html/JuliaInterface/chap0_mj.html`). This is not really nice, but I did not find another solution. When Documenter.jl (in version 1.0 or higher) checks the document's structure, it does not accept relative links outside the build directory, and apparently there is no option to suppress this check. (One could think of encoding the links in question as `http://..` URLs in the document, and inserting a new step into the build process, after the checks of course, which just replaces these URLs by the intended relative ones. I think this would be absurd.)
I do not understand the test outputs: And I do not understand how the changes from this pull request can cause this behaviour. |
Hmm, this situation is strange. After all, Documenter.jl explicitly has this "assets" feature to add files from outside, and so I don't understand why they would block it. Perhaps there is a "trick" we are missing? Could you perhaps open an issue on the Documenter.jl repository, including the precise error you are getting, and with a request for guidance? I think "we need to bundle some pre-built HTML pages" is not that outlandish a request... |
As to the errors, they may be temporary? Let's close and re-open to see |
Codecov Report
@@ Coverage Diff @@
## master #953 +/- ##
==========================================
+ Coverage 75.70% 75.74% +0.04%
==========================================
Files 51 51
Lines 4169 4169
==========================================
+ Hits 3156 3158 +2
+ Misses 1013 1011 -2 |
@fingolfin Thanks for the feedback. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
works now just fine
(as in AbstractAlgebra.jl and Nemo.jl)
For that, I have changed the three cross-references to the JuliaInterface manual from relative
(pointing to
../assets/html/JuliaInterface/chap0_mj.html
) to absolute(pointing to
https://oscar-system.github.io/GAP.jl/stable/assets/html/JuliaInterface/chap0_mj.html
).This is not really nice, but I did not find another solution. When Documenter.jl (in version 1.0 or higher) checks the document's structure, it does not accept relative links outside the build directory, and apparently there is no option to suppress this check.
(One could think of encoding the links in question as
https://..
URLs in the document, and inserting a new step into the build process, after the checks of course, which just replaces these URLs by the intended relative ones. I think this would be absurd.If it would be possible to insert inline HTML code then the solution would be easy, but apparently this is not intended.)