[yt-svn] commit/yt: 8 new changesets
commits-noreply at bitbucket.org
commits-noreply at bitbucket.org
Thu Mar 16 12:00:43 PDT 2017
8 new commits in yt:
https://bitbucket.org/yt_analysis/yt/commits/0cbe50b295bd/
Changeset: 0cbe50b295bd
Branch: yt
User: ngoldbaum
Date: 2017-03-07 00:58:24+00:00
Summary: Only build the API docs if READTHEDOCS is not set to True
Affected #: 1 file
diff -r 1088ca4ac8d84017d1809a6f114c852297286350 -r 0cbe50b295bdeae5aaac2a05a6e03c595929bad3 doc/Makefile
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -47,9 +47,11 @@
-rm -rf _temp/*.done source/cookbook/_static/*
html:
+ifneq ($(READTHEDOCS),True)
sphinx-apidoc -o source/reference/api/ -e ../yt ../yt/extern/* \
$(shell find ../yt -name "*tests*" -type d) ../yt/utilities/voropp*
sed -e '/show-inheritance/ a\ \ \ \ :inherited-members:' -i source/reference/api/yt*.rst
+endif
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
https://bitbucket.org/yt_analysis/yt/commits/592fb55ed410/
Changeset: 592fb55ed410
Branch: yt
User: ngoldbaum
Date: 2017-03-07 00:58:40+00:00
Summary: Use perl instead of sed for string replacement for better portability
Affected #: 1 file
diff -r 0cbe50b295bdeae5aaac2a05a6e03c595929bad3 -r 592fb55ed410d066d77bbecde5b743e34ee782bd doc/Makefile
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -50,7 +50,7 @@
ifneq ($(READTHEDOCS),True)
sphinx-apidoc -o source/reference/api/ -e ../yt ../yt/extern/* \
$(shell find ../yt -name "*tests*" -type d) ../yt/utilities/voropp*
- sed -e '/show-inheritance/ a\ \ \ \ :inherited-members:' -i source/reference/api/yt*.rst
+ perl -i -p -e 's/show-inheritance/inherited-members/g;' source/reference/api/yt*.rst
endif
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
https://bitbucket.org/yt_analysis/yt/commits/704492974864/
Changeset: 704492974864
Branch: yt
User: ngoldbaum
Date: 2017-03-07 00:59:24+00:00
Summary: Deprecate the fullclean build rule now that building the API docs is cheap
Affected #: 1 file
diff -r 592fb55ed410d066d77bbecde5b743e34ee782bd -r 70449297486484e7b8ed040190e586bf85015b1a doc/Makefile
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -33,15 +33,14 @@
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " clean to remove the build directory"
- @echo " fullclean to remove the build directory and autogenerated api docs"
@echo " recipeclean to remove files produced by running the cookbook scripts"
clean:
-rm -rf $(BUILDDIR)/*
+ -rm -rf source/reference/api/yt.*
+ -rm -rf source/reference/api/modules.rst
-fullclean:
- -rm -rf $(BUILDDIR)/*
- -rm -rf source/reference/api/generated
+fullclean: clean
recipeclean:
-rm -rf _temp/*.done source/cookbook/_static/*
https://bitbucket.org/yt_analysis/yt/commits/b201fd20d3e4/
Changeset: b201fd20d3e4
Branch: yt
User: ngoldbaum
Date: 2017-03-07 01:00:06+00:00
Summary: Fix sphinx build warnings from use of deprecated stuff
Affected #: 1 file
diff -r 70449297486484e7b8ed040190e586bf85015b1a -r b201fd20d3e401e708e356e38e5f0d0156c70985 doc/source/conf.py
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -30,7 +30,7 @@
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx',
- 'sphinx.ext.pngmath', 'sphinx.ext.viewcode',
+ 'sphinx.ext.mathjax', 'sphinx.ext.viewcode',
'sphinx.ext.napoleon', 'yt_cookbook', 'yt_colormaps',
'config_help']
@@ -229,11 +229,11 @@
#latex_show_urls = False
# Additional stuff for the LaTeX preamble.
-latex_preamble = r"""
+latex_elements = dict(preamble=r"""
\renewcommand{\AA}{\text{\r{A}}} % Allow \AA in math mode
\usepackage[utf8]{inputenc} % Allow unicode symbols in text
\DeclareUnicodeCharacter {212B} {\AA} % Angstrom
-"""
+""")
# Documents to append as an appendix to all manuals.
#latex_appendices = []
https://bitbucket.org/yt_analysis/yt/commits/f6fb13e64a7a/
Changeset: f6fb13e64a7a
Branch: yt
User: ngoldbaum
Date: 2017-03-07 01:41:37+00:00
Summary: avoid using perl by specifying inherited_members in sphinx-apidoc call
Affected #: 1 file
diff -r b201fd20d3e401e708e356e38e5f0d0156c70985 -r f6fb13e64a7a31fda81816c485b65c79ea3659f8 doc/Makefile
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -47,9 +47,9 @@
html:
ifneq ($(READTHEDOCS),True)
- sphinx-apidoc -o source/reference/api/ -e ../yt ../yt/extern/* \
- $(shell find ../yt -name "*tests*" -type d) ../yt/utilities/voropp*
- perl -i -p -e 's/show-inheritance/inherited-members/g;' source/reference/api/yt*.rst
+ SPHINX_APIDOC_OPTIONS=members,undoc-members,inherited-members,show-inheritance sphinx-apidoc \
+ -o source/reference/api/ \
+ -e ../yt ../yt/extern/* $(shell find ../yt -name "*tests*" -type d) ../yt/utilities/voropp*
endif
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
https://bitbucket.org/yt_analysis/yt/commits/dd8d2563770b/
Changeset: dd8d2563770b
Branch: yt
User: ngoldbaum
Date: 2017-03-07 19:14:21+00:00
Summary: clean up imports in sphinx conf.py
Affected #: 1 file
diff -r f6fb13e64a7a31fda81816c485b65c79ea3659f8 -r dd8d2563770beb734d8998d87aa410f92d6ea22f doc/source/conf.py
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -11,9 +11,9 @@
# All configuration values have a default; values that are commented out
# serve to show the default.
-import sys, os, glob, re
-from sphinx.search import WordCollector
-from docutils.nodes import comment, title, Text, SkipNode
+import sys
+import os
+import glob
on_rtd = os.environ.get("READTHEDOCS", None) == "True"
https://bitbucket.org/yt_analysis/yt/commits/8a8691edcb11/
Changeset: 8a8691edcb11
Branch: yt
User: ngoldbaum
Date: 2017-03-07 19:30:33+00:00
Summary: don't try to render angstrom symbol
Affected #: 2 files
diff -r dd8d2563770beb734d8998d87aa410f92d6ea22f -r 8a8691edcb11068b7efbc603515d267f607465a7 doc/source/analyzing/analysis_modules/star_analysis.rst
--- a/doc/source/analyzing/analysis_modules/star_analysis.rst
+++ b/doc/source/analyzing/analysis_modules/star_analysis.rst
@@ -209,8 +209,8 @@
There are two ways to write out the data once the spectrum has been calculated.
The command ``write_out`` outputs two columns of data:
- 1. Wavelength :math:`(\text{\AA})`
- 2. Flux (Luminosity per unit wavelength :math:`(\mathrm{\rm{L}_\odot} / \text{\AA})` , where
+ 1. Wavelength (:math:`\text{Angstroms}`)
+ 2. Flux (Luminosity per unit wavelength :math:`(\mathrm{\rm{L}_\odot} / \text{Angstrom})` , where
:math:`\mathrm{\rm{L}_\odot} = 3.826 \cdot 10^{33}\, \mathrm{ergs / s}` ).
and can be called simply, specifying the output file:
@@ -225,7 +225,7 @@
distribution to. The default is 5200 Angstroms. This command outputs the data
in two columns:
- 1. Wavelength :math:`(\text{\AA})`
+ 1. Wavelength :math:`(\text{Angstroms})`
2. Relative flux normalized to the flux at *flux_norm*.
.. code-block:: python
diff -r dd8d2563770beb734d8998d87aa410f92d6ea22f -r 8a8691edcb11068b7efbc603515d267f607465a7 doc/source/conf.py
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -228,13 +228,6 @@
# If true, show URL addresses after external links.
#latex_show_urls = False
-# Additional stuff for the LaTeX preamble.
-latex_elements = dict(preamble=r"""
-\renewcommand{\AA}{\text{\r{A}}} % Allow \AA in math mode
-\usepackage[utf8]{inputenc} % Allow unicode symbols in text
-\DeclareUnicodeCharacter {212B} {\AA} % Angstrom
-""")
-
# Documents to append as an appendix to all manuals.
#latex_appendices = []
https://bitbucket.org/yt_analysis/yt/commits/9e4ea1785be2/
Changeset: 9e4ea1785be2
Branch: yt
User: ngoldbaum
Date: 2017-03-16 19:00:35+00:00
Summary: Merged in ngoldbaum/yt (pull request #2540)
Documentation build cleanups
Approved-by: Kacper Kowalik
Approved-by: Matt Turk
Affected #: 3 files
diff -r 49a8249197b2ee0a2e57db04b4f426c530349fd1 -r 9e4ea1785be27ff3aed67249bc941d6f4be54f00 doc/Makefile
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -33,23 +33,24 @@
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " clean to remove the build directory"
- @echo " fullclean to remove the build directory and autogenerated api docs"
@echo " recipeclean to remove files produced by running the cookbook scripts"
clean:
-rm -rf $(BUILDDIR)/*
+ -rm -rf source/reference/api/yt.*
+ -rm -rf source/reference/api/modules.rst
-fullclean:
- -rm -rf $(BUILDDIR)/*
- -rm -rf source/reference/api/generated
+fullclean: clean
recipeclean:
-rm -rf _temp/*.done source/cookbook/_static/*
html:
- sphinx-apidoc -o source/reference/api/ -e ../yt ../yt/extern/* \
- $(shell find ../yt -name "*tests*" -type d) ../yt/utilities/voropp*
- sed -e '/show-inheritance/ a\ \ \ \ :inherited-members:' -i source/reference/api/yt*.rst
+ifneq ($(READTHEDOCS),True)
+ SPHINX_APIDOC_OPTIONS=members,undoc-members,inherited-members,show-inheritance sphinx-apidoc \
+ -o source/reference/api/ \
+ -e ../yt ../yt/extern/* $(shell find ../yt -name "*tests*" -type d) ../yt/utilities/voropp*
+endif
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
diff -r 49a8249197b2ee0a2e57db04b4f426c530349fd1 -r 9e4ea1785be27ff3aed67249bc941d6f4be54f00 doc/source/analyzing/analysis_modules/star_analysis.rst
--- a/doc/source/analyzing/analysis_modules/star_analysis.rst
+++ b/doc/source/analyzing/analysis_modules/star_analysis.rst
@@ -209,8 +209,8 @@
There are two ways to write out the data once the spectrum has been calculated.
The command ``write_out`` outputs two columns of data:
- 1. Wavelength :math:`(\text{\AA})`
- 2. Flux (Luminosity per unit wavelength :math:`(\mathrm{\rm{L}_\odot} / \text{\AA})` , where
+ 1. Wavelength (:math:`\text{Angstroms}`)
+ 2. Flux (Luminosity per unit wavelength :math:`(\mathrm{\rm{L}_\odot} / \text{Angstrom})` , where
:math:`\mathrm{\rm{L}_\odot} = 3.826 \cdot 10^{33}\, \mathrm{ergs / s}` ).
and can be called simply, specifying the output file:
@@ -225,7 +225,7 @@
distribution to. The default is 5200 Angstroms. This command outputs the data
in two columns:
- 1. Wavelength :math:`(\text{\AA})`
+ 1. Wavelength :math:`(\text{Angstroms})`
2. Relative flux normalized to the flux at *flux_norm*.
.. code-block:: python
diff -r 49a8249197b2ee0a2e57db04b4f426c530349fd1 -r 9e4ea1785be27ff3aed67249bc941d6f4be54f00 doc/source/conf.py
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -11,9 +11,9 @@
# All configuration values have a default; values that are commented out
# serve to show the default.
-import sys, os, glob, re
-from sphinx.search import WordCollector
-from docutils.nodes import comment, title, Text, SkipNode
+import sys
+import os
+import glob
on_rtd = os.environ.get("READTHEDOCS", None) == "True"
@@ -30,7 +30,7 @@
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx',
- 'sphinx.ext.pngmath', 'sphinx.ext.viewcode',
+ 'sphinx.ext.mathjax', 'sphinx.ext.viewcode',
'sphinx.ext.napoleon', 'yt_cookbook', 'yt_colormaps',
'config_help']
@@ -228,13 +228,6 @@
# If true, show URL addresses after external links.
#latex_show_urls = False
-# Additional stuff for the LaTeX preamble.
-latex_preamble = r"""
-\renewcommand{\AA}{\text{\r{A}}} % Allow \AA in math mode
-\usepackage[utf8]{inputenc} % Allow unicode symbols in text
-\DeclareUnicodeCharacter {212B} {\AA} % Angstrom
-"""
-
# Documents to append as an appendix to all manuals.
#latex_appendices = []
Repository URL: https://bitbucket.org/yt_analysis/yt/
--
This is a commit notification from bitbucket.org. You are receiving
this because you have the service enabled, addressing the recipient of
this email.
More information about the yt-svn
mailing list