Having some trouble updating stdlib docs

104 views
Skip to first unread message

Spencer Russell

unread,
Sep 18, 2015, 5:35:24 PM9/18/15
to juli...@googlegroups.com
I’m trying to update some docs in stdlib for the first time, and I don’t see my changes in the generated docs. I changed some things in base/docs/helpdb.jl, then I rebuilt julia (`make`) then ran `julia doc/genstdlib.jl` then built the HTML docs with `make -C doc html`. When I run the version of Julia that I built I see my updated docs in the help info, but I don’t see the changes when I open the HTML docs in `doc/_build/html`.

Am I missing a step? I’m trying to follow the instructions in CONTRIBUTING.md.

Also running genstdlib gives me this output - https://gist.github.com/ssfrr/aee377cbbf12baf8d404. Is that what I should expect?

Yichao Yu

unread,
Sep 18, 2015, 8:37:34 PM9/18/15
to Julia Dev
On Fri, Sep 18, 2015 at 5:35 PM, Spencer Russell <s...@media.mit.edu> wrote:
> I’m trying to update some docs in stdlib for the first time, and I don’t see my changes in the generated docs. I changed some things in base/docs/helpdb.jl, then I rebuilt julia (`make`) then ran `julia doc/genstdlib.jl`

You mean `./julia doc/genstdlib.jl` ?

Spencer Russell

unread,
Sep 18, 2015, 11:24:06 PM9/18/15
to juli...@googlegroups.com
Ah! That’s it. I hadn’t really understood that when you run genstdlib it’s not re-parsing the helpdb.jl, but that step happens when you build Julia itself. I was indeed using the wrong julia build, which also explains why I was seeing other stuff not related to my change after running genstdlib.

Thanks for the catch!

-s

Yichao Yu

unread,
Sep 18, 2015, 11:27:13 PM9/18/15
to Julia Dev
On Fri, Sep 18, 2015 at 11:23 PM, Spencer Russell <s...@media.mit.edu> wrote:
> Ah! That’s it. I hadn’t really understood that when you run genstdlib it’s not re-parsing the helpdb.jl, but that step happens when you build Julia itself. I was indeed using the wrong julia build, which also explains why I was seeing other stuff not related to my change after running genstdlib.

Yep. This is why you need to build julia first..... =)
Reply all
Reply to author
Forward
0 new messages