Skip to content

Commit 5680c3a

Browse files
eteqeteq
authored
Merge pull request #153 from adrn/sphinx
Switch tutorial infrastructure to use Sphinx
2 parents 910cc51 + ee479d0 commit 5680c3a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+1728
-1877
lines changed

‎.gitignore

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
.ipynb_checkpoints/
2-
html/
3-
runipy-*
2+
build/
3+
tutorials/rst-tutorials/
44
IPython-*
5-
tutorials/*/_run_*
6-
tutorials/*/*.fits
7-
tutorials/*/*.pdf
8-
tutorials/*/*.png
5+
*.fits
6+
*.pdf
7+
*.png
8+
*.jpg
99
*.pyc
10+
*.tex
11+
exec*.ipynb

‎.gitmodules

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "astropy_helpers"]
2+
path = astropy_helpers
3+
url = https://github.com/astropy/astropy-helpers.git

‎.rtd-environment.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: tutorials
2+
3+
channels:
4+
- astropy
5+
6+
dependencies:
7+
- python=3.6
8+
- IPython=6.1.0
9+
- astropy=2.0
10+
- astroquery=0.3.6
11+
- matplotlib=2.0.2
12+
- numpy=1.13.1
13+
- scipy=0.19 # needed for coordinates cross-matching
14+
- jupyter=1.0
15+
- notebook=5.0
16+
- pip:
17+
- git+https://github.com/jupyter/nbconvert # this is really >=5.4, but at the time of adding this that wasn't yet available

‎.travis.yml

Lines changed: 39 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,52 @@
11
language: c
22

3-
sudo: false
4-
53
os:
64
- linux
75

6+
sudo: false
7+
8+
addons:
9+
apt:
10+
packages:
11+
- graphviz
12+
- texlive-latex-extra
13+
- dvipng
14+
815
env:
916
global:
17+
1018
- PYTHON_VERSION=3.6
11-
- SETUP_XVFB=True
12-
- CONDA_ENVIRONMENT=conda-environment.yml
13-
- CONDA_DEPENDENCIES='jupyter notebook ipython runipy'
14-
- GH_REF: github.com/astropy/astropy-tutorials.git
15-
- secure: "NBZlEg//sDYvJikqXESLsx/WA1Nj7fAH2mJfI8ZVMnolvyjJuLdEMxxEYFP8t6U/iieSSrgUkgP94yy5Oq6iJRjj7ThGCdcjgvgWTQCzoQgEVDc5SzdJGyGs30VC+8t7GTobzMe086HX16SJRvsIumqXdmRcJjAdMCyhMUxLoUg="
19+
- NUMPY_VERSION=stable
20+
- ASTROPY_VERSION=stable
21+
- EVENT_TYPE='pull_request push'
22+
23+
- CONDA_ENVIRONMENT='conda-environment.yml'
24+
- CONDA_DEPENDENCIES='jupyter ipython'
25+
- CONDA_CHANNELS='astropy-ci-extras astropy'
26+
27+
# We need to install the master/latest version of nbconvert because it has support for
28+
# allowing exceptions in individual cells:
29+
- PIP_DEPENDENCIES='git+https://github.com/jupyter/nbconvert'
30+
31+
# matrix:
32+
33+
# # Don't wait for allowed failures
34+
# fast_finish: true
35+
36+
# include:
37+
38+
# - os: linux
39+
# env: SETUP_CMD='test --coverage'
1640

1741
install:
18-
- git clone git://github.com/astropy/ci-helpers.git
42+
43+
- git clone --depth 1 git://github.com/astropy/ci-helpers.git
1944
- source ci-helpers/travis/setup_conda.sh
2045

2146
script:
22-
- python prepare_deploy.py run
23-
24-
deploy:
25-
provider: script
26-
script: ./travis_deploy
27-
on:
28-
repo: astropy/astropy-tutorials
29-
branch: master
47+
# - |
48+
# python scripts/convert.py docs/_static/tutorials/ -v
49+
# --output-path=docs/rst-tutorials
50+
# --template=docs/_static/astropy.tpl
51+
- python scripts/convert.py tutorials/notebooks --exec-only -v
52+

‎DEPLOY.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

‎Makefile

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
# Makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
PAPER =
8+
BUILDDIR = build
9+
10+
# Internal variables.
11+
PAPEROPT_a4 = -D latex_paper_size=a4
12+
PAPEROPT_letter = -D latex_paper_size=letter
13+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) tutorials
14+
15+
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
16+
17+
help:
18+
@echo "Please use \`make <target>' where <target> is one of"
19+
@echo " html to make standalone HTML files"
20+
@echo " dirhtml to make HTML files named index.html in directories"
21+
@echo " singlehtml to make a single large HTML file"
22+
@echo " pickle to make pickle files"
23+
@echo " json to make JSON files"
24+
@echo " htmlhelp to make HTML files and a HTML help project"
25+
@echo " qthelp to make HTML files and a qthelp project"
26+
@echo " devhelp to make HTML files and a Devhelp project"
27+
@echo " epub to make an epub"
28+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
29+
@echo " latexpdf to make LaTeX files and run them through pdflatex"
30+
@echo " text to make text files"
31+
@echo " man to make manual pages"
32+
@echo " changes to make an overview of all changed/added/deprecated items"
33+
@echo " linkcheck to check all external links for integrity"
34+
@echo " tutorials to convert all tutorials to RST"
35+
36+
clean:
37+
-rm -rf $(BUILDDIR)
38+
-rm -rf api
39+
-rm -rf generated
40+
41+
html:
42+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
43+
@echo
44+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
45+
46+
dirhtml:
47+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
48+
@echo
49+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
50+
51+
singlehtml:
52+
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
53+
@echo
54+
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
55+
56+
pickle:
57+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
58+
@echo
59+
@echo "Build finished; now you can process the pickle files."
60+
61+
json:
62+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
63+
@echo
64+
@echo "Build finished; now you can process the JSON files."
65+
66+
htmlhelp:
67+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
68+
@echo
69+
@echo "Build finished; now you can run HTML Help Workshop with the" \
70+
".hhp project file in $(BUILDDIR)/htmlhelp."
71+
72+
qthelp:
73+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
74+
@echo
75+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
76+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
77+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Astropy.qhcp"
78+
@echo "To view the help file:"
79+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Astropy.qhc"
80+
81+
devhelp:
82+
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
83+
@echo
84+
@echo "Build finished."
85+
@echo "To view the help file:"
86+
@echo "# mkdir -p $$HOME/.local/share/devhelp/Astropy"
87+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Astropy"
88+
@echo "# devhelp"
89+
90+
epub:
91+
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
92+
@echo
93+
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
94+
95+
latex:
96+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
97+
@echo
98+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
99+
@echo "Run \`make' in that directory to run these through (pdf)latex" \
100+
"(use \`make latexpdf' here to do that automatically)."
101+
102+
latexpdf:
103+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
104+
@echo "Running LaTeX files through pdflatex..."
105+
make -C $(BUILDDIR)/latex all-pdf
106+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
107+
108+
text:
109+
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
110+
@echo
111+
@echo "Build finished. The text files are in $(BUILDDIR)/text."
112+
113+
man:
114+
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
115+
@echo
116+
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
117+
118+
changes:
119+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
120+
@echo
121+
@echo "The overview file is in $(BUILDDIR)/changes."
122+
123+
linkcheck:
124+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
125+
@echo
126+
@echo "Link check complete; look for any errors in the above output " \
127+
"or in $(BUILDDIR)/linkcheck/output.txt."
128+
129+
doctest:
130+
@echo "Run 'python setup.py test' in the root directory to run doctests " \
131+
@echo "in the documentation."

‎README.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

‎README.rst

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
Astropy Tutorials
2+
=================
3+
4+
This repository contains tutorials for the `Astropy <http://astropy.org>`_
5+
project. These are typically longer-form, more narrative presentations of
6+
functionality in the `Astropy core package
7+
<https://github.com/astropy/astropy>`_ and any `affiliated packages
8+
<http://www.astropy.org/affiliated/index.html>`_. The tutorials are therefore
9+
different from the `Astropy core package documentation
10+
<http://docs.astropy.org>`_, which presents a more structured and exhaustive
11+
view of the core package.
12+
13+
To see the tutorials rendered as static web pages, see the `Astropy tutorials
14+
site <http://tutorials.astropy.org>`_.
15+
16+
To run the tutorials interactively, you'll need to make sure you have `Jupyter
17+
notebook <http://jupyter.org/>`_ installed, then clone or download this
18+
repository. The notebook files themselves live in the ``tutorials`` directory
19+
of this repository, organized by the names of the tutorials.
20+
21+
You can also get started quickly using `Binder <http://mybinder.org>`_ to run the tutorials in
22+
your web browser within a remote server:
23+
24+
.. image:: http://mybinder.org/badge.svg
25+
:target: http://mybinder.org/repo/astropy/astropy-tutorials/docs/tutorials
26+
27+
Contributing tutorial material
28+
------------------------------
29+
30+
Please see the "`For contributors
31+
<http://astropy-tutorials.readthedocs.io/en/latest/#for-contributors>`_" section
32+
of the tutorials documentation for information on how to get started.

‎astropy_helpers

Submodule astropy_helpers added at aaa4506

‎conda-environment.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,6 @@ dependencies:
1010
- astroquery=0.3.6
1111
- matplotlib=2.0.2
1212
- numpy=1.13.1
13+
- scipy=0.19 # needed for coordinates cross-matching
14+
- jupyter=1.0
15+
- notebook=5.0

0 commit comments

Comments
 (0)