Skip to content

Commit

Permalink
doc: update Makefile and README
Browse files Browse the repository at this point in the history
  • Loading branch information
pao committed May 28, 2013
1 parent ee461cc commit 8af6759
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 31 deletions.
43 changes: 23 additions & 20 deletions doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -45,38 +45,41 @@ help:
clean:
-rm -rf $(BUILDDIR)/*

html:
juliadoc-pkg:
pip install --user --upgrade -r requirements.txt

html: juliadoc-pkg
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

dirhtml:
dirhtml: juliadoc-pkg
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."

singlehtml:
singlehtml: juliadoc-pkg
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."

pickle:
pickle: juliadoc-pkg
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."

json:
json: juliadoc-pkg
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."

htmlhelp:
htmlhelp: juliadoc-pkg
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."

qthelp:
qthelp: juliadoc-pkg
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
Expand All @@ -85,7 +88,7 @@ qthelp:
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/JuliaLanguage.qhc"

devhelp:
devhelp: juliadoc-pkg
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
Expand All @@ -94,69 +97,69 @@ devhelp:
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/JuliaLanguage"
@echo "# devhelp"

epub:
epub: juliadoc-pkg
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."

latex:
latex: juliadoc-pkg
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."

latexpdf:
latexpdf: juliadoc-pkg
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."

text:
text: juliadoc-pkg
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."

man:
man: juliadoc-pkg
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."

texinfo:
texinfo: juliadoc-pkg
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."

info:
info: juliadoc-pkg
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."

gettext:
gettext: juliadoc-pkg
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."

changes:
changes: juliadoc-pkg
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."

linkcheck:
linkcheck: juliadoc-pkg
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."

doctest:
doctest: juliadoc-pkg
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."

helpdb.jl: stdlib/*.rst
helpdb.jl: stdlib/*.rst juliadoc-pkg
$(SPHINXBUILD) -b jlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/jlhelp
mv $(BUILDDIR)/jlhelp/jlhelp.jl helpdb.jl

Expand Down
8 changes: 5 additions & 3 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,10 @@ File layout

conf.py Sphinx configuration
helpdb.jl REPL help database
sphinx/ Sphinx extensions and plugins
sphinx/jlhelp.py Sphinx plugin to build helpdb.jl
stdlib/ Julia standard library documentation
_themes/ Sphinx html themes

Sphinx extensions and theme
---------------------------
The extensions to Sphinx and the theme are in the
https://github.com/JuliaLang/JuliaDoc repository, and can also be used to style
package documentation.
18 changes: 10 additions & 8 deletions doc/helpdb.jl
Original file line number Diff line number Diff line change
Expand Up @@ -490,7 +490,8 @@
("Iterable Collections","Base","unique","unique(itr)
Returns an array containing only the unique elements of the
iterable \"itr\".
iterable \"itr\", in the order that the first of each set of
equivalent elements originally appears.
"),

Expand Down Expand Up @@ -547,6 +548,13 @@
"),

("Iterable Collections","Base","sum","sum(f, itr)
Sum the results of calling function \"f\" on each element of
\"itr\".
"),

("Iterable Collections","Base","prod","prod(itr)
Returns the product of all elements of a collection
Expand All @@ -565,13 +573,7 @@
"),

("Iterable Collections","Base","count","count(itr) -> Integer
Count the number of boolean elements in \"itr\" which are true.
"),

("Iterable Collections","Base","countp","countp(p, itr) -> Integer
("Iterable Collections","Base","count","count(p, itr) -> Integer
Count the number of elements in \"itr\" for which predicate \"p\"
is true.
Expand Down

0 comments on commit 8af6759

Please sign in to comment.