juliadocs / documentationgenerator.jl Goto Github PK

It is, IMO, unfortunate that Julia's docs are hosted at pkg.julialang.org. We should have one canonical place for the base documentation. Could we just build a search-index and link to the official docs instead of also hosting them?

In the left search column, there is a dropdown menu to select package version to show docs for. It only shows the latest version, even if one can manually navigate to other versions by changing the version number in the URL.
Example
https://pkg.julialang.org/docs/JuliaInterpreter/PliIn/0.5.0/
https://pkg.julialang.org/docs/JuliaInterpreter/PliIn/0.5.1/
both exist, but only 0.5.1 is shown in the dropdown

check this link: https://pkg.julialang.org/docs/Yao/TDiQQ/0.4.2/

PS. will pkg.julialang.org only render the README? I thought it will provide the documentation as well, but it seems all of our doc string is missing at the moment in pkg.julialang.org, and if I just search our example, it won't appear...

Would be nice if the dark mode setting is remembered. But may be non-trivial since I assume that needs cookies and state.

I want users to always end up at the official Query.jl and friend docs at https://www.queryverse.org/Query.jl/stable/, not a copy hosted somewhere else. What pkg.julialang.org does right now feels a bit like hijacking of docs :) Would be good to have a simple way to opt-out.

I also think it would be good if that was implemented rather sooner than later.

e.g. from https://pkg.julialang.org/docs/search?q=hello you can not search for packages.

It would be really valuable to have a total number of packages on the landing page for pkg.julialang.org and a directory or some kind of browsable list of all packages linked from the landing page.

In the Docstrings section it's not very enlightening to list all functions without docstrings. For example in my Inflate package I have deliberately chosen to have docstrings only for the exported functions. I would suggest removing all functions without docstrings from the Docstrings list.

Also regardless of docstrings there's little point listing the eval and include functions that automatically exist in every module.

I am the author, let me know if there is anything I can fix on my end.

repo: https://github.com/tpapp/DynamicHMC.jl

The rust crates.io includes a download number at the bottom.
https://crates.io/crates/rand
Adding this interface could help finding packages as well as evidence of use for maintainers, which can help seek funds.

In discourse, Stefan said that the new package system "...removes the burden from package developers of figuring out how to host docs and provide search functionality." I like this; I don't want to host package documentation, and I think it would be valuable to have all the documentation in a single place. One thing that would facilitate this is having a stable per-package URL that package creators can link to from their package github page.

I made the package LLLplus. I updated it recently to v1.2.0, and the new docs are available at https://pkg.julialang.org/docs/LLLplus/zQjW4/1.2.0/ I'd like to be able to link to either https://pkg.julialang.org/docs/LLLplus (or maybe a URL ending in "latest") from a "docs" button on my package page and have that redirect to the latest manual for my package. Unfortunately I can't do that now, because https://pkg.julialang.org/docs/LLLplus gives me a 'Forbidden' error.

Sometimes you need to detect who is building the docs. For example, for Literate.jl I want to predict URLs to the final output. On Travis this is easy; I detect that code is running on Travis, and use TRAVIS_REPO_SLUG to guess a GitHub URL, and similar for embedding links to nbviewer.org for generated notebook files, see e.g. @__REPO__ROOT_URL__ from https://fredrikekre.github.io/Literate.jl/stable/fileformat/#Default-Replacements-1

The problem now is that the docs built by DocumentationGenerator have wrong links, since its not beeing built on Travis, compare e.g. the show nbviewer links here https://fredrikekre.github.io/Literate.jl/stable/generated/example/ and here https://pkg.julialang.org/docs/Literate/XPnWG/1.1.0/generated/example/

I think what I need from DocumentationGenerator is the following:

• Some way to detect that docs are being built by DocumentationGenerator e.g. DOCUMENTATIONGENERATOR="true"
• Some environment variable for the final base URL where the docs will be deployed, e.g. DOCUMENTATIONGENERATOR_BASEURL="pkg.julialang.org/docs/Literate/XPnWG/1.1.0/" so that I can query where the docs currently beeing built will be deployed.

I am apparently getting annoyed by stuff that can't be clicked, see #32

This is related to #29, in that I was trying to get to the latest URL,
and so tried just deleting the version part.
It would be resolved by just making this a full HTTP redirect.

the CSS is broken if you do not include the version number
See
https://pkg.julialang.org/docs/NamedDims/EBrgX/
vs
https://pkg.julialang.org/docs/NamedDims/EBrgX/0.2.0/
The problem is that stylesheet links to sheets given assets below are relative paths,
those asset folders exist in the version subdirectory

<link href="assets/documenter.css" rel="stylesheet" type="text/css">

so displaying same content from different endpoint breaks them.

https://pkg.julialang.org/docs/Nemo/SPUMD/0.9.1 does not look like http://nemocas.github.io/Nemo.jl/latest/

https://pkg.julialang.org/docs/UnicodePlots/Ctj9q/1.1.0/LICENSE.md

Gives me a 404

If this is where issues should be reported, it would be nice for the webpage to have a link to here so it's easier to find!

If you're a package author and your package is missing from pkg.julialang.org, please post a comment here and I'll add it to this post.

• https://github.com/tpapp/DynamicHMC.jl -- works locally, added to tests
• https://github.com/thofma/Hecke.jl -- works locally, added to tests
• https://github.com/isaacsas/ReactionNetworkImporters.jl -- works locally, added to tests
• QuantEcon.jl
• GeoStats.jl -- is there but only shows fallback docs

Flux docs here https://pkg.julialang.org/docs/Flux/QdkVy/0.8.2/ are not the same as the Flux docs on the flux website: https://fluxml.ai/Flux.jl/stable/

@MikeInnes

Searching for chisq on pkg.julialang.org does not give results for the Distributions.jl package

Seems like we want to code quote @api here:

The github markdown to produce strikethrough text ~~text~~ does not render correctly, it renders verbatim. See e.g. here

As requested from Slack, I'm just posting that my package, ReactionNetworkImporters.jl, which is in METADATA and the general registry doesn't seem to be showing up at pkg.julialang.org. Note, I have no docs for the package (but do have a README, and just added tags).

Feel free to close if this is redundant with other issues.

So that you could link to an exact package search (i.e. when searching by name and/or tag). I guess something like https://pkg.julialang.org/docs/?q=foo&tags=bar,baz.

Not sure how useful it would be, but when opening #61, my initial reaction was to just drop a link to the exact query I made.

e.g. https://pkg.julialang.org/docs/foo/bar/baz takes you to home...

https://github.com/thofma/Hecke.jl

Search e.g. Example.jl.

It would be great if there was some way of coordinating the redundant tags, for example there is a math and a mathematics tag… maybe the result lists could be combined for words like that.

All it would take is a list of synomyms, so that equivalent words and tags get grouped.

Along with the github link for a package, many packages have their own websites. It would be nice to link those. We can pick it up from the project description which has a URL field:

Would be cool if I could supply a project manifest to the filer list so search and package display only considers project relevant packages.

Many MIT licenses are being detected as Other.

Example: DataFrames.

This will indicate whether

• we received response for a search query
• sometimes there will zero results for docs sections or non zero for code. User has no way of knowing this unless he switches the tab

It looks odd to have that (c) 2019 in the footer there. I think we can just delete it.

See here.

cc @vdayanand.

Clinking on the link leads to https://pkg.julialang.org/docs/DifferentialEquations/UQdwS/6.7.0/ and not http://docs.juliadiffeq.org/latest/ . The DiffEqDocs should be easy to build if they need to be re-built for this: it's all static.

It would be helpful if a link to the repository were available in the package's documentation.

This should probably be implemented in a way that works well with the homepage link (#24).

It is annoying that you can't click JuliaLang/Example here:

Search for GitHub.jl and click on the documentation. It throws an authentication box.

While searching for a tag and clicking a tag, the list of packages updates in the background. When trying to hide the left search column to reveal the found packages, another, empty tag is inserted and the list of found packages becomes empty.

This occurs on Chrome android. Let me know of this proves hard to reproduce and I'll try to upload some screenshots somewhere. It has happened on my phone every time since my first visit at the new site.

But it's MIT:

https://github.com/JuliaDiffEq/DifferentialEquations.jl/blob/master/LICENSE.md

For example, see the top of: https://pkg.julialang.org/docs/Flux/QdkVy/0.8.2/

This is one click away from pkg.julialang.org.

FWIW, I think the GeoStats issue comes from here

which is removing custom assets arguments (cf. GeoStats make.jl).

Originally posted by @mortenpi in #15 (comment)

var DOC_VERSIONS = ['1.2.0,1.2.1,index.html,versions.js']; is wrong.