Skip to content

Commit 2849356

Browse files
author
Takaya Uchida
committed
readthedocs works locally
1 parent aae7987 commit 2849356

File tree

99 files changed

+29365
-2386
lines changed

Some content is hidden

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

99 files changed

+29365
-2386
lines changed

‎.gitignore

Lines changed: 60 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,60 @@
1-
*.pyc
2-
*~
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
5+
# C extensions
6+
*.so
7+
8+
# Distribution / packaging
9+
.Python
10+
env/
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
*.egg-info/
23+
.installed.cfg
24+
*.egg
25+
26+
# PyInstaller
27+
# Usually these files are written by a python script from a template
28+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
29+
*.manifest
30+
*.spec
31+
32+
# Installer logs
33+
pip-log.txt
34+
pip-delete-this-directory.txt
35+
36+
# Unit test / coverage reports
37+
htmlcov/
38+
.tox/
39+
.coverage
40+
.coverage.*
41+
.cache
42+
nosetests.xml
43+
coverage.xml
44+
*,cover
45+
46+
# Translations
47+
*.mo
48+
*.pot
49+
50+
# Django stuff:
51+
*.log
52+
53+
# Sphinx documentation
54+
docs/_build/
55+
56+
# PyBuilder
57+
target/
58+
59+
# notebook
60+
*/.ipynb_checkpoints/*

‎LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2015 Ariel Rokem, The University of Washington eScience Institute
3+
Copyright (c) 2017 Ryan Abernathey, Columbia University
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,12 @@
33
[![Build Status](https://travis-ci.org/rabernat/xrft.svg?branch=master)](https://travis-ci.org/rabernat/xrft)
44

55
[![codecov](https://codecov.io/gh/rabernat/xrft/branch/master/graph/badge.svg)](https://codecov.io/gh/rabernat/xrft)
6+
7+
8+
xrft is a Python package for
9+
taking the discrete Fourier transform (DFT) on xarray_ and dask_ arrays.
10+
It is
11+
12+
- **Powerful**: It keeps the metadata and coordinates of the original xarray dataset and provides a clean work flow of DFT.
13+
- **Easy-to-use**: It uses the native arguments of numpy fft and provides a simple, high-level API.
14+
- **Fast**: It uses the dask API of fft and map_blocks to allow parallelization of DFT.

‎doc/.ipynb_checkpoints/DFT-checkpoint.ipynb

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"cells": [],
3+
"metadata": {},
4+
"nbformat": 4,
5+
"nbformat_minor": 2
6+
}

‎doc/.ipynb_checkpoints/Power_spectrum-checkpoint.ipynb

Lines changed: 306 additions & 0 deletions
Large diffs are not rendered by default.

‎doc/DFT.ipynb

Lines changed: 273 additions & 0 deletions
Large diffs are not rendered by default.

‎doc/Makefile

Lines changed: 10 additions & 169 deletions
Original file line numberDiff line numberDiff line change
@@ -1,179 +1,20 @@
1-
# Makefile for Sphinx documentation
1+
# Minimal makefile for Sphinx documentation
22
#
33

44
# You can set these variables from the command line.
55
SPHINXOPTS =
66
SPHINXBUILD = sphinx-build
7-
PAPER =
7+
SPHINXPROJ = xrft
8+
SOURCEDIR = .
89
BUILDDIR = _build
910

10-
# User-friendly check for sphinx-build
11-
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
12-
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
13-
endif
14-
15-
# Internal variables.
16-
PAPEROPT_a4 = -D latex_paper_size=a4
17-
PAPEROPT_letter = -D latex_paper_size=letter
18-
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
19-
# the i18n builder cannot share the environment and doctrees with the others
20-
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
21-
22-
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
23-
11+
# Put it first so that "make" without argument is like "make help".
2412
help:
25-
@echo "Please use \`make <target>' where <target> is one of"
26-
@echo " html to make standalone HTML files"
27-
@echo " dirhtml to make HTML files named index.html in directories"
28-
@echo " singlehtml to make a single large HTML file"
29-
@echo " pickle to make pickle files"
30-
@echo " json to make JSON files"
31-
@echo " htmlhelp to make HTML files and a HTML help project"
32-
@echo " qthelp to make HTML files and a qthelp project"
33-
@echo " devhelp to make HTML files and a Devhelp project"
34-
@echo " epub to make an epub"
35-
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
36-
@echo " latexpdf to make LaTeX files and run them through pdflatex"
37-
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
38-
@echo " text to make text files"
39-
@echo " man to make manual pages"
40-
@echo " texinfo to make Texinfo files"
41-
@echo " info to make Texinfo files and run them through makeinfo"
42-
@echo " gettext to make PO message catalogs"
43-
@echo " changes to make an overview of all changed/added/deprecated items"
44-
@echo " xml to make Docutils-native XML files"
45-
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
46-
@echo " linkcheck to check all external links for integrity"
47-
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
48-
49-
50-
clean:
51-
rm -rf $(BUILDDIR)/*
52-
rm -rf reference/*
53-
54-
html:
55-
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
56-
@echo
57-
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
58-
59-
dirhtml:
60-
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
61-
@echo
62-
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
63-
64-
singlehtml:
65-
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
66-
@echo
67-
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
68-
69-
pickle:
70-
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
71-
@echo
72-
@echo "Build finished; now you can process the pickle files."
73-
74-
json:
75-
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
76-
@echo
77-
@echo "Build finished; now you can process the JSON files."
78-
79-
htmlhelp:
80-
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
81-
@echo
82-
@echo "Build finished; now you can run HTML Help Workshop with the" \
83-
".hhp project file in $(BUILDDIR)/htmlhelp."
84-
85-
qthelp:
86-
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
87-
@echo
88-
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
89-
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
90-
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/shablona.qhcp"
91-
@echo "To view the help file:"
92-
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/shablona.qhc"
93-
94-
devhelp:
95-
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
96-
@echo
97-
@echo "Build finished."
98-
@echo "To view the help file:"
99-
@echo "# mkdir -p $$HOME/.local/share/devhelp/shablona"
100-
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/shablona"
101-
@echo "# devhelp"
102-
103-
epub:
104-
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
105-
@echo
106-
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
107-
108-
latex:
109-
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
110-
@echo
111-
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
112-
@echo "Run \`make' in that directory to run these through (pdf)latex" \
113-
"(use \`make latexpdf' here to do that automatically)."
114-
115-
latexpdf:
116-
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
117-
@echo "Running LaTeX files through pdflatex..."
118-
$(MAKE) -C $(BUILDDIR)/latex all-pdf
119-
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
120-
121-
latexpdfja:
122-
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
123-
@echo "Running LaTeX files through platex and dvipdfmx..."
124-
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
125-
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
126-
127-
text:
128-
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
129-
@echo
130-
@echo "Build finished. The text files are in $(BUILDDIR)/text."
131-
132-
man:
133-
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
134-
@echo
135-
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
136-
137-
texinfo:
138-
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
139-
@echo
140-
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
141-
@echo "Run \`make' in that directory to run these through makeinfo" \
142-
"(use \`make info' here to do that automatically)."
143-
144-
info:
145-
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
146-
@echo "Running Texinfo files through makeinfo..."
147-
make -C $(BUILDDIR)/texinfo info
148-
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
149-
150-
gettext:
151-
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
152-
@echo
153-
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
154-
155-
changes:
156-
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
157-
@echo
158-
@echo "The overview file is in $(BUILDDIR)/changes."
159-
160-
linkcheck:
161-
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
162-
@echo
163-
@echo "Link check complete; look for any errors in the above output " \
164-
"or in $(BUILDDIR)/linkcheck/output.txt."
165-
166-
doctest:
167-
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
168-
@echo "Testing of doctests in the sources finished, look at the " \
169-
"results in $(BUILDDIR)/doctest/output.txt."
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
17014

171-
xml:
172-
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
173-
@echo
174-
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
15+
.PHONY: help Makefile
17516

176-
pseudoxml:
177-
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
178-
@echo
179-
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

0 commit comments

Comments
 (0)