Skip to content
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

Make helpdb.jl and docs as part of build #2501

Closed
pao opened this issue Mar 7, 2013 · 16 comments
Closed

Make helpdb.jl and docs as part of build #2501

pao opened this issue Mar 7, 2013 · 16 comments
Labels
building Build system, or building Julia or its dependencies docs This change adds or pertains to documentation
Milestone

Comments

@pao
Copy link
Member

pao commented Mar 7, 2013

Now that binary builds are a reality, it might be time for us to stop checking in helpdb.jl and make Sphinx a build dependency. We could consider making it an option so you could choose not to build the docs (another Make variable?)

This has implications for the work @wlbksy is doing in #2499.

@wlbksy
Copy link
Contributor

wlbksy commented Mar 11, 2013

I managed to generate the Chinese version. Personally speaking, I think it's better not to do what you have said. Tell people if they want to modify manual's content, just modify any .rst file in manual/ and stdlib/ .

As for i18n , each language's maintainer can maintain their own helpdb.jl all alone. We can provide a link from here to each translation project.

@wlbksy
Copy link
Contributor

wlbksy commented Mar 11, 2013

I guess it doesn't matter if helpdb.jl is not so up to date. People who don't know how to generate helpdb.jl can just wait the maintainer do it for them. Let alone there are lots of people who even not want to install python or sphinx.

@pao
Copy link
Member Author

pao commented Mar 11, 2013

People who don't know how to generate helpdb.jl are most likely going to get Julia from a binary build; either the Windows or Mac binaries from julialang.org, or Linux binaries from their distro. I'd like to be sure that users getting binary builds get the most up-to-date helpdb we can give them.

@nolta
Copy link
Member

nolta commented Mar 11, 2013

I've added this to the 1.0 milestones, since i agree we should do this, but not now.

@pao
Copy link
Member Author

pao commented Mar 11, 2013

That's fine.

@vtjnash
Copy link
Member

vtjnash commented Oct 8, 2014

@pao can we close this?

@pao
Copy link
Member Author

pao commented Oct 8, 2014

@ViralBShah
Copy link
Member

@staticfloat @tkelman What do you guys feel about doing this, and autogenerating helpdb.jl - requiring sphinx as a build dependency. I think we are ready for it.

@ViralBShah
Copy link
Member

Of course, non-existence of sphinx should be detected and become a warning, rather than fail the build.

@tkelman
Copy link
Contributor

tkelman commented Jan 2, 2015

Worth trying a PR for it, sure. Especially now that we've got the virtualenv stuff hooked up. It's making our build more reliant on Python's package manager working properly, but we can try it out. I haven't timed make -C doc, about how much time would it add to the Travis build? I'd want to skip it (so fail fast or add a simple variable to disable it) on AppVeyor if it takes any more than about 30-60 seconds, to avoid making the queue any longer.

@ViralBShah
Copy link
Member

make helpdb.jl is 47 seconds on my mac, which includes getting all the deps and setting up the virtualenv.

@tkelman
Copy link
Contributor

tkelman commented Jan 2, 2015

It's about 50 seconds using Cygwin's python, not too bad. I think AppVeyor probably has a win32 python on the path. I'd probably want to disable it on all the CI except Travis, maybe even do helpdb.jl (along with code style / whitespace checks) in a separate build matrix entry.

@ViralBShah
Copy link
Member

That seems quite reasonable.

tkelman added a commit that referenced this issue Jan 2, 2015
also build docs in the same matrix job, ref #8917 and #2501

remove comments from .travis.yml [av skip]

Change multiline commands in Travis to use &&
tkelman added a commit that referenced this issue Jan 2, 2015
also build docs in the same matrix job, ref #8917 and #2501

remove comments from .travis.yml [av skip]

Change multiline commands in Travis to use &&

don't build with sphinx in pedantic mode
@staticfloat
Copy link
Member

Since we have the virtualenv stuff working pretty well now, I think it's definitely worth a shot as a separate build matrix entry. Debian does this with their arch-independent build targets. :P

@tkelman
Copy link
Contributor

tkelman commented Jan 3, 2015

see #9553 and #9554

tkelman added a commit that referenced this issue Jan 8, 2015
also build docs in the same matrix job, ref #8917 and #2501

remove comments from .travis.yml [av skip]

Change multiline commands in Travis to use &&

don't build with sphinx in pedantic mode
@tkelman
Copy link
Contributor

tkelman commented Jun 28, 2015

With #11906 I think this can be closed. AIUI helpdb.jl is now the manually created version, but will be gradually separated out into docstrings at definitions instead.

@tkelman tkelman closed this as completed Jun 28, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
building Build system, or building Julia or its dependencies docs This change adds or pertains to documentation
Projects
None yet
Development

No branches or pull requests

7 participants