-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
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
Doc hard, and with a vengeance #11943
Merged
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
96fd316
fix identation
MikeInnes 4a86729
newdoc.jl generates docs/helpdb.jl
MikeInnes bc1d852
generate new helpdb
MikeInnes 1d97152
include helpdb.jl
MikeInnes fa4110d
remove newdoc.jl
MikeInnes 6636796
new doc city: remove traces of the old helpdb.jl
StefanKarpinski 55339fc
further help removals
MikeInnes be7f7c6
genstdlib.jl regenerates the manual
MikeInnes dfc7168
regenerate the manual
MikeInnes b980d09
add stdlib generation to build
MikeInnes File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -48,7 +48,7 @@ endif | |
julia-deps: | $(DIRS) $(build_datarootdir)/julia/base $(build_datarootdir)/julia/test $(build_docdir) $(build_sysconfdir)/julia/juliarc.jl $(build_man1dir)/julia.1 | ||
@$(MAKE) $(QUIET_MAKE) -C deps | ||
|
||
julia-base: julia-deps $(build_docdir)/helpdb.jl | ||
julia-base: julia-deps | ||
@$(MAKE) $(QUIET_MAKE) -C base | ||
|
||
julia-libccalltest: | ||
|
@@ -82,6 +82,7 @@ endif | |
|
||
release-candidate: release testall | ||
@$(JULIA_EXECUTABLE) contrib/add_license_to_files.jl #add license headers | ||
@$(JULIA_EXECUTABLE) doc/genstdlib.jl | ||
@#Check documentation | ||
@$(JULIA_EXECUTABLE) doc/NEWS-update.jl #Add missing cross-references to NEWS.md | ||
@$(MAKE) -C doc unicode #Rebuild Unicode table if necessary | ||
|
@@ -96,7 +97,6 @@ release-candidate: release testall | |
@$(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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. please add the new doc building steps here instead |
||
@$(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 \ | ||
|
@@ -124,9 +124,6 @@ release-candidate: release testall | |
@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 $< $@ | ||
|
@@ -183,7 +180,7 @@ $(build_private_libdir)/inference.ji: $(build_private_libdir)/inference0.ji | |
|
||
COMMA:=, | ||
define sysimg_builder | ||
$$(build_private_libdir)/sys$1.o: $$(build_private_libdir)/inference.ji VERSION $$(BASE_SRCS) $$(build_docdir)/helpdb.jl | ||
$$(build_private_libdir)/sys$1.o: $$(build_private_libdir)/inference.ji VERSION $$(BASE_SRCS) | ||
@$$(call PRINT_JULIA, cd base && \ | ||
$$(call spawn,$2) -C $$(JULIA_CPU_TARGET) --output-o $$(call cygpath_w,$$@) $$(JULIA_SYSIMG_BUILD_FLAGS) -f \ | ||
-J $$(call cygpath_w,$$<) sysimg.jl \ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder if it would be more obvious that these were generated files (and so shouldn't be changed) if it was
/_stdlib/*.rst
.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should actually delete this line, since the rst files are only partially auto-generated. Best to just commit both copies of the docstrings for now I think.