Skip to content

Commit

Permalink
Run DocCheck to detect undocumented items
Browse files Browse the repository at this point in the history
  • Loading branch information
@jiahao @staticfloat
jiahao authored and staticfloat committed Aug 5, 2014
1 parent f727f0e commit 1b1c889
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion Makefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,9 @@ debug release: | $(DIRS) $(build_datarootdir)/julia/base $(build_datarootdir)/ju

release-candidate-checklist: release test source-dist
@#Check documentation
./julia doc/NEWS-update.jl #Add missing cross-references to NEWS.md
@./julia doc/NEWS-update.jl #Add missing cross-references to NEWS.md
@./julia doc/DocCheck.jl > doc/UNDOCUMENTED.rst 2>&1 #Check for undocumented items

This comment has been minimized.

Sign in to view

Copy link
@tkelman

tkelman Oct 5, 2016

Contributor

this never did anything because DocCheck.jl is a module, not a script
@if [ -n "$(cat doc/UNDOCUMENTED.rst)" ]; then rm doc/UNDOCUMENTED.rst; else echo -1. Write documentation for the items in doc/UNDOCUMENTED.rst; exit 1 fi
@$(MAKE) -C doc html SPHINXOPTS="-W" #Rebuild Julia HTML docs pedantically
@$(MAKE) -C doc latex SPHINXOPTS="-W" #Rebuild Julia PDF docs pedantically
@$(MAKE) -C doc doctest #Run Julia doctests
Expand Down

0 comments on commit 1b1c889

Please sign in to comment.