WIP: re-export localindexes [ci skip]

[timholy]

Ref #12412 (comment)

[tkelman]

removing too many exports isn't necessarily a bad thing...

[timholy]

Sure, if we want to leave this un-exported, that would be fine. But since it seems to have been an accident, I thought I'd raise it for discussion. CC @amitmurthy.

[amitmurthy]

I am for re-exporting, now that SharedArrays are not being marked as experimental and because this is a useful api for work partitioning.

[timholy]

@one-more-minute, I just rebased this attempting to work with the new documentation system. (The "Blah blah" part of this commit is obviously something I might have to reevaluate, so consider this a WIP 😄.)

Unfortunately, after make && make -C doc html I get this:

help?> localindexes
search: localindexes


julia>

and this:

Can you provide a bit more guidance about how we're supposed to proceed? I've read both http://docs.julialang.org/en/latest/manual/documentation/ and https://groups.google.com/d/msg/julia-users/eI-mZe2zA-c/kmc7RdPPAQAJ, is there some other place I should be looking?

[MikeInnes]

Not sure if the doc stuff will run as part of make, but you can force it with julia doc/genstdlib.jl. The other thing to be wary of is that we don't completely support documenting things before the doc system is loaded, which looks like it might be the case here, so you could try putting the docstring in base/docs/basedocs.jl to see if that helps.

[timholy]

Moving to base/docs/basedocs.jl made ?localindexes work, thanks!

But no dice on the RST documentation (still "Blah blah"). I did this order:

make
./julia doc/genstdlib.jl
make -C doc html
firefox doc/_build/html/index.html &

[MikeInnes]

Ah, I forgot – since your docstring is in Markdown it needs #12435 in order to output to RST. If you leave it as it is I'll make sure that gets fixed as part of that PR.

[tkelman]

Would it help to just push the RST rendering backend part of that PR (and a test) to master? Rendering currently-markdown docstrings into RST is something people are going to want to do now, but converting all of the RST in helpdb into markdown might take a while to get totally right.

[MikeInnes]

Yeah, that makes sense, I went ahead and pushed that commit, so that should make things easier for this PR.

[timholy]

I rebased on top of aff076d, but without moving the docstring to base/docs/basedocs.jl, I'm still not getting anything for either version (REPL or RST docs). Should I just leave this here and let you play with it?

[StefanKarpinski]

??

[timholy]

This was me testing the new documentation system---see the history in #12423. This will not be part of the final commit.

[timholy]

Subsumed in 9c595c3

[tkelman]

The doc addition for it wasn't though?

[timholy]

Good point. Leaving this open, short on time right now.

[timholy]

Superseded by #14532.