Skip to content

Commit

Permalink
improve html doc layout on mobile devices
Browse files Browse the repository at this point in the history
  • Loading branch information
nolta authored and pao committed May 27, 2013
1 parent e8a223a commit 5636a7c
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 46 deletions.
1 change: 0 additions & 1 deletion doc/.gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
_build/
_themes/julia/static/jquery.js
32 changes: 8 additions & 24 deletions doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,8 @@ ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

JQUERYDEST = _themes/julia/static/jquery.js
JQUERYURL = http:https://code.jquery.com/jquery-latest.js
WGET = $(abspath ../deps)/jldownload

.PHONY: help clean clean-jquery cleanall get-jquery html dirhtml singlehtml pickle json htmlhelp qthelp devhelp \
epub latex latexpdf text man changes linkcheck doctest gettext listpkg
.PHONY: help clean cleanall html dirhtml singlehtml pickle json htmlhelp qthelp devhelp \
epub latex latexpdf text man changes linkcheck doctest gettext

help:
@echo "Please use \`make <target>' where <target> is one of"
Expand All @@ -44,33 +40,21 @@ help:
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " listpkg to recreate the list of available packages"

clean:
-rm -rf $(BUILDDIR)/*
-rm -f sphinx/*.pyc

clean-jquery:
-rm -f $(JQUERYDEST)

cleanall: clean clean-jquery

get-jquery: $(JQUERYDEST)

$(JQUERYDEST):
$(WGET) $@ $(JQUERYURL)

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

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

singlehtml: get-jquery
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
Expand All @@ -85,13 +69,13 @@ json:
@echo
@echo "Build finished; now you can process the JSON files."

htmlhelp: get-jquery
htmlhelp:
$(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: get-jquery
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
Expand Down Expand Up @@ -171,7 +155,7 @@ doctest:
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."

helpdb.jl: stdlib/*.rst sphinx/jlhelp.py sphinx/julia.py
helpdb.jl: stdlib/*.rst
$(SPHINXBUILD) -b jlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/jlhelp
mv $(BUILDDIR)/jlhelp/jlhelp.jl helpdb.jl

Expand Down
9 changes: 3 additions & 6 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@
#html_additional_pages = {}

# If false, no module index is generated.
html_domain_indices = False
#html_domain_indices = True

# If false, no index is generated.
#html_use_index = True
Expand Down Expand Up @@ -188,16 +188,13 @@
\DeclareUnicodeCharacter{2203}{\ensuremath{\exists}}
\DeclareUnicodeCharacter{2200}{\ensuremath{\forall}}
\DeclareUnicodeCharacter{27FA}{\ensuremath{\Longleftrightarrow}}
\usepackage{amsfonts}
\DeclareUnicodeCharacter{2713}{\checkmark}
\usepackage{CJKutf8}
''',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('latex', 'JuliaLanguage.tex', u'Julia Language Documentation',
('index', 'JuliaLanguage.tex', u'Julia Language Documentation',
AUTHORS, 'manual'),
]

Expand All @@ -219,7 +216,7 @@
#latex_appendices = []

# If false, no module index is generated.
latex_domain_indices = False
#latex_domain_indices = True


# -- Options for manual page output --------------------------------------------
Expand Down
9 changes: 2 additions & 7 deletions doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,20 +1,15 @@

%%%%%%%%%%%%%%%%%%%%%
Julia Documentation
%%%%%%%%%%%%%%%%%%%%%

.. toctree::
:maxdepth: 1
:maxdepth: 2

manual/index
stdlib/index
packages/packagelist

Index and search
================

* :ref:`genindex`
* :ref:`search`

Translations
============

Expand Down
3 changes: 0 additions & 3 deletions doc/manual/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@
The Julia Manual
##################

:Release: |version|
:Date: |today|

.. toctree::
:maxdepth: 1

Expand Down
5 changes: 0 additions & 5 deletions doc/stdlib/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@
The Julia Standard Library
############################

:Release: |version|
:Date: |today|

*********
Built-ins
*********
Expand All @@ -32,5 +29,3 @@ Built-in Modules
collections
sort
test


0 comments on commit 5636a7c

Please sign in to comment.