Skip to content

Commit

Permalink
Use Jupyter for nbconvert.
Browse files Browse the repository at this point in the history
  • Loading branch information
paugier committed Oct 1, 2015
1 parent 7c54d08 commit 89c7c38
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 9 deletions.
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ FluidSim

*Framework for studying fluid dynamics by numerical simulation.*

`Package Documentation <http://fluidsim.readthedocs.org/en/latest/>`__
`Package Documentation <http://fluidsim.readthedocs.org>`__

FluidSim is the numerically oriented package of the `FluidDyn project
<http://fluiddyn.readthedocs.org/en/latest/>`__. The project is still in a
<http://fluiddyn.readthedocs.org>`__. The project is still in a
testing stage so it is still pretty unstable and many of its planned
features have not yet been implemented.

Expand Down
5 changes: 1 addition & 4 deletions doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ clean:
cleanall: clean
rm -rf generated html.zip

html: $(IPYTHON_NOTEBOOKS_RST)
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
Expand Down Expand Up @@ -164,6 +164,3 @@ doctest:

zip: html
cd _build/html && zip -r html.zip * && mv html.zip ../../.

%.rst: %.ipynb
cd $(IPYNB_DIR) && ipython nbconvert --to rst $(notdir $<)
4 changes: 3 additions & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@
from fluidrtd import mock_modules
mock_modules(['h5py'])

from fluidrtd.ipynb_maker import ipynb_to_rst
ipynb_to_rst()

import fluidsim


Expand All @@ -46,7 +49,6 @@
'sphinx.ext.viewcode', 'sphinx.ext.autosummary',
'numpydoc',
'mathmacro',
'IPython.sphinxext.ipython_directive'
]

# Add any paths that contain templates here, relative to this directory.
Expand Down
4 changes: 2 additions & 2 deletions doc/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
cython
ipython[notebook]>=3.0.0
jupyter
numpy
matplotlib
scipy
fluiddyn>=0.0.10a7
fluiddyn>=0.0.11a1
Sphinx>=1.1
numpydoc

0 comments on commit 89c7c38

Please sign in to comment.