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

WIP: Doc Transition #11828

Closed
wants to merge 27 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
b2663f1
helpdb conversion
MikeInnes Jun 23, 2015
cd639a5
remove redundant qualifiers
MikeInnes Jun 23, 2015
fc43d63
basic rst rendering
MikeInnes Jun 27, 2015
19840a3
new doc city: delete old helpdb.jl and things that depends on it
StefanKarpinski Jun 27, 2015
db6eccf
stdlib generating script
MikeInnes Jun 27, 2015
49deb27
delete newdoc.jl
MikeInnes Jun 27, 2015
f66b9c0
convert help to markdown yay
MikeInnes Jun 27, 2015
a392a04
remove rst special casing
MikeInnes Jun 27, 2015
70a360a
print with a prefix
MikeInnes Jun 27, 2015
6e865a5
first conversion from doc->rst
MikeInnes Jun 27, 2015
5e375cd
RST's handling of quotes is seriously weird
MikeInnes Jun 27, 2015
362ac82
handle signatures better
MikeInnes Jun 27, 2015
a079cd2
get rid of those pesky signatures
MikeInnes Jun 27, 2015
97da3dc
don't leave trailing whitespace
MikeInnes Jun 27, 2015
af429c2
get rid of those pesky whitespaces
MikeInnes Jun 27, 2015
a100499
new doc city: forward-port changes to old helpdb.jl from past week
StefanKarpinski Jun 28, 2015
93a2a30
wip: fixing missing/out-of-date stuff in new helpdb.jl
StefanKarpinski Jun 28, 2015
4340aca
temporarily add back an up-to-date doc/helpdb.jl from master
StefanKarpinski Jun 28, 2015
89c7e91
add getdoc back
MikeInnes Jun 28, 2015
9be5f63
fix helpdb.jl
MikeInnes Jun 28, 2015
068b7da
new manual
MikeInnes Jun 28, 2015
1e88207
convert to markdown, again
MikeInnes Jun 28, 2015
bf8786b
regen
MikeInnes Jun 28, 2015
ab4f5f1
avoid blockquote
MikeInnes Jun 28, 2015
08b4f65
wip
StefanKarpinski Jun 28, 2015
ec3541a
now we repeat ourselves a *lot* but we aren't missing anything
StefanKarpinski Jun 28, 2015
4e86137
delete doc/helpdb.jl again
StefanKarpinski Jun 28, 2015
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ Make sure that [Travis](http://www.travis-ci.org) greenlights the pull request w
- Try to [squash](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html) together small commits that make repeated changes to the same section of code so your pull request is easier to review, and Julia's history won't have any broken intermediate commits. A reasonable number of separate well-factored commits is fine, especially for larger changes.
- If any conflicts arise due to changes in Julia's `master`, prefer updating your pull request branch with `git rebase` versus `git merge` or `git pull`, since the latter will introduce merge commits that clutter the git history with noise that makes your changes more difficult to review.
- If you see any unrelated changes to submodules like `deps/libuv`, `deps/openlibm`, etc., try running `git submodule update` first.
- Avoid committing changes to auto-generated files such as `doc/helpdb.jl`, which is a frequent source of conflicts and can be re-generated later.
- Avoid committing changes to auto-generated files such as `doc/stdlib/*.rst`, which is a frequent source of conflicts and can be re-generated later.
- Descriptive commit messages are good.
- Using `git add -p` or `git add -i` can be useful to avoid accidentally committing unrelated changes.
- GitHub does not send notifications when you push a new commit to a pull request, so please add a comment to the pull request thread to let reviewers know when you've made changes.
Expand Down
6 changes: 1 addition & 5 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,6 @@ release-candidate: release test
@$(MAKE) -C doc latex SPHINXOPTS="-n" #Rebuild Julia PDF docs pedantically
@$(MAKE) -C doc doctest #Run Julia doctests
@$(MAKE) -C doc linkcheck #Check all links
@$(MAKE) -C doc helpdb.jl #Rebuild Julia online documentation for help(), apropos(), etc...

@# Check to see if the above make invocations changed anything important
@if [ -n "$$(git status --porcelain)" ]; then \
Expand Down Expand Up @@ -117,9 +116,6 @@ release-candidate: release test
@echo 10. Change master to release-0.X in base/version.jl and base/version_git.sh as in 4cb1e20
@echo

$(build_docdir)/helpdb.jl: doc/helpdb.jl | $(build_docdir)
@cp $< $@

$(build_man1dir)/julia.1: doc/man/julia.1 | $(build_man1dir)
@mkdir -p $(build_man1dir)
@cp $< $@
Expand Down Expand Up @@ -188,7 +184,7 @@ JULIA_SYSIMG_BUILD_FLAGS += --output-ji $(call cygpath_w,$(build_private_libdir)
endif

COMMA:=,
$(build_private_libdir)/sys.o: VERSION $(BASE_SRCS) $(build_docdir)/helpdb.jl $(build_private_libdir)/inference.$(SHLIB_EXT)
$(build_private_libdir)/sys.o: VERSION $(BASE_SRCS) $(build_private_libdir)/inference.$(SHLIB_EXT)
@$(call PRINT_JULIA, cd base && \
$(call spawn,$(JULIA_EXECUTABLE)) -C $(JULIA_CPU_TARGET) --output-o $(call cygpath_w,$(build_private_libdir)/sys.o) $(JULIA_SYSIMG_BUILD_FLAGS) -f \
-J $(call cygpath_w,$(build_private_libdir)/inference.$(SHLIB_EXT)) sysimg.jl \
Expand Down
5 changes: 1 addition & 4 deletions base/docs/Docs.jl
Original file line number Diff line number Diff line change
Expand Up @@ -493,10 +493,7 @@ macro repl (ex)
if $(isfield(ex) ? :(isa($(esc(ex.args[1])), DataType)) : false)
$(isfield(ex) ? :(fielddoc($(esc(ex.args[1])), $(ex.args[2]))) : nothing)
else
# Backwards-compatible with the previous help system, for now
let doc = @doc $(esc(ex))
doc ≠ nothing ? doc : Base.Help.@help_ $(esc(ex))
end
@doc $(esc(ex))
end
end
end
Expand Down
Loading