Plenty Duplicate docs or Missing docstrings messages after update to a new version #1139
Labels
Comments
|
I looked through your docs and everything looks to be in order. But I am not sure it's version you were building, since when I tried to build your master branch locally, but it does not precompile (with Julia 1.2.0): |
|
I thank you for your time. I am still working with Julia 1.1 which is probably more permissible. I am about to install Julia 1.2.0 and I will try to update the package to compile with this version. I hope it will work also with the documentation. |
|
A colleague produced the documentation without any missing parts. I wonder
if Documenter has a kind of memory which impedes the repeated generation of
documentation on my local computer. It is possible to "reinitialize"
Documenter to start from its initial state? Many thanks in advane for your
answer.
Morten Piibeleht <[email protected]> schrieb am So., 6. Okt. 2019,
03:44:
… I looked through your docs and everything looks to be in order. But I am
not sure it's version you were building, since when I tried to build your
master branch locally, but it does not precompile (with Julia 1.2.0):
$ julia --project make.jl
ERROR: LoadError: LoadError: syntax: local variable name "T" conflicts with a static parameter
Stacktrace:
[1] top-level scope at /home/mortenpi/Julia/test/MatrixEquations.jl/src/sylvester.jl:564
[2] include at ./boot.jl:328 [inlined]
[3] include_relative(::Module, ::String) at ./loading.jl:1094
[4] include at ./Base.jl:31 [inlined]
[5] include(::String) at /home/mortenpi/Julia/test/MatrixEquations.jl/src/MatrixEquations.jl:1
[6] top-level scope at /home/mortenpi/Julia/test/MatrixEquations.jl/src/MatrixEquations.jl:28
[7] include at ./boot.jl:328 [inlined]
[8] include_relative(::Module, ::String) at ./loading.jl:1094
[9] include(::Module, ::String) at ./Base.jl:31
[10] top-level scope at none:2
[11] eval at ./boot.jl:330 [inlined]
[12] eval(::Expr) at ./client.jl:432
[13] top-level scope at ./none:3
in expression starting at /home/mortenpi/Julia/test/MatrixEquations.jl/src/sylvester.jl:564
in expression starting at /home/mortenpi/Julia/test/MatrixEquations.jl/src/MatrixEquations.jl:28
ERROR: LoadError: Failed to precompile MatrixEquations [99c1a7ee-ab34-5fd5-8076-27c950a045f4] to /home/mortenpi/.julia/compiled/v1.2/MatrixEquations/1uOBF.ji.
Stacktrace:
[1] error(::String) at ./error.jl:33
[2] compilecache(::Base.PkgId, ::String) at ./loading.jl:1253
[3] _require(::Base.PkgId) at ./loading.jl:1013
[4] require(::Base.PkgId) at ./loading.jl:911
[5] require(::Module, ::Symbol) at ./loading.jl:906
[6] include at ./boot.jl:328 [inlined]
[7] include_relative(::Module, ::String) at ./loading.jl:1094
[8] include(::Module, ::String) at ./Base.jl:31
[9] exec_options(::Base.JLOptions) at ./client.jl:295
[10] _start() at ./client.jl:464
in expression starting at /home/mortenpi/Julia/test/MatrixEquations.jl/docs/make.jl:1
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#1139?email_source=notifications&email_token=ALJDHEEJR3ZJPX5CJZA4LDDQNE7F7A5CNFSM4I4XVIH2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEAN7RSA#issuecomment-538704072>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/ALJDHECVL4XEIN6NAHRJ7JLQNE7F7ANCNFSM4I4XVIHQ>
.
|
|
Same problem here. It works fine on a Mac but gives a lot of "duplicate docs found" warnings on Ubuntu18.04. Both machines are running Julia v1.2.0 and Documenter v0.23.3. |
|
Now I know what's going on. The cause is a bit funny. On my Ubuntu machine I used Jupyter Lab to edit the Markdown file (which has a nice preview feature) and it created some temp files. So when I printed Everything got duplicated! After removing the temp files, everything runs fine. It would be nice if Documenter could automatically filters out such hidden files. |
|
Hmm, this is interesting. I am slightly hesitant to add this type of automagical behavior where Documenter would just ignore these files. But we could maybe print silenceable warnings. |
|
There are not only warnings. In my case, the parts of respective documentation are not included.
Von: Morten Piibeleht [mailto:[email protected]]
Gesendet: Dienstag, 8. Oktober 2019 23:53
An: JuliaDocs/Documenter.jl
Cc: andreasvarga; Author
Betreff: Re: [JuliaDocs/Documenter.jl] Plenty Duplicate docs or Missing docstrings messages after update to a new version (#1139)
Hmm, this is interesting. I am slightly hesitant to add this type of automagical behavior where Documenter would just ignore these files. But we could maybe print silenceable warnings.
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub <#1139?email_source=notifications&email_token=ALJDHECEMOWW73UTSSEOIHLQNT6MPA5CNFSM4I4XVIH2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEAVXSBQ#issuecomment-539719942> , or mute the thread <https://github.com/notifications/unsubscribe-auth/ALJDHEHOZF6NJAA7H3U55CDQNT6MPANCNFSM4I4XVIHQ> . <https://github.com/notifications/beacon/ALJDHEHE2MBLC3ZCHGLMDMDQNT6MPA5CNFSM4I4XVIH2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEAVXSBQ.gif>
[ { "@context": "http://schema.org", "@type": "EmailMessage", "potentialAction": { "@type": "ViewAction", "target": "#1139?email_source=notifications\u0026email_token=ALJDHECEMOWW73UTSSEOIHLQNT6MPA5CNFSM4I4XVIH2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEAVXSBQ#issuecomment-539719942", "url": "#1139?email_source=notifications\u0026email_token=ALJDHECEMOWW73UTSSEOIHLQNT6MPA5CNFSM4I4XVIH2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEAVXSBQ#issuecomment-539719942", "name": "View Issue" }, "description": "View this Issue on GitHub", "publisher": { "@type": "Organization", "name": "GitHub", "url": "https://github.com" } } ]
|
|
So this happens because you don't explicitly define what pages you want to include with the |
|
I did have |
|
In the meantime I succeeded to produce the documentation correctly. The
problem was the presence of two subdirectories /docs/src/lib and
/docs/src/internal which each contained an .md file with commands to
produce documentation. These files duplicated other two .md files with the
same commands in the directory /docs/src. After deleting the two
subdirectories, everything went well.
Bin Liang <[email protected]> schrieb am Di., 15. Okt. 2019, 21:32:
… I did have pages=[...] in my makedoc(). But it still picked up the hidden
files.
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#1139?email_source=notifications&email_token=ALJDHEBWSQW4TXLF5JF2WSTQOYLF3A5CNFSM4I4XVIH2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEBJ6PQA#issuecomment-542369728>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/ALJDHEEL4DZU2Q3AW47PTILQOYLF3ANCNFSM4I4XVIHQ>
.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
I updated my Julia software https://github.com/andreasvarga/MatrixEquations.jl to version V1.0 and during generation of the documention I got plenty of warning messages like the following one:
In the previous version, there were no such messages and all functions have been properly documented. Now, after the update, I am not anymore able to obtain the documentation with all functions included (see snapshot below). Curriously enough, the documentation for the newly added function
MatrixEquations.LapackUtil.lacn2!is included. Similarly happens in another section, where no function is included (see below). I would appreciate any hint how to try to debug this issue. Thanks in advance.The text was updated successfully, but these errors were encountered: