[yt-svn] commit/yt: 6 new changesets
commits-noreply at bitbucket.org
commits-noreply at bitbucket.org
Wed Jul 5 13:36:25 PDT 2017
6 new commits in yt:
https://bitbucket.org/yt_analysis/yt/commits/cbadd60ea10a/
Changeset: cbadd60ea10a
User: qobilidop
Date: 2017-07-04 18:08:47+00:00
Summary: Update environment variable
Affected #: 1 file
diff -r ac06c5d6adcf34d370202204df9a255427428514 -r cbadd60ea10afc8c90b061917477f37daa59db57 doc/source/developing/building_the_docs.rst
--- a/doc/source/developing/building_the_docs.rst
+++ b/doc/source/developing/building_the_docs.rst
@@ -137,11 +137,11 @@
.. code-block:: bash
- cd $YT_HG/doc
+ cd $YT_GIT/doc
make html
This will produce an html version of the documentation locally in the
-``$YT_HG/doc/build/html`` directory. You can now go there and open
+``$YT_GIT/doc/build/html`` directory. You can now go there and open
up ``index.html`` or whatever file you wish in your web browser.
Building the Docs (Full)
@@ -192,7 +192,7 @@
.. code-block:: bash
- cd $YT_HG/doc
+ cd $YT_GIT/doc
make html
If all of the dependencies are installed and all of the test data is in the
https://bitbucket.org/yt_analysis/yt/commits/04e0af143dc8/
Changeset: 04e0af143dc8
User: qobilidop
Date: 2017-07-04 18:19:47+00:00
Summary: Check grammar
Affected #: 1 file
diff -r cbadd60ea10afc8c90b061917477f37daa59db57 -r 04e0af143dc8b174f6a8339581fa5d94cd39ce2a doc/source/developing/building_the_docs.rst
--- a/doc/source/developing/building_the_docs.rst
+++ b/doc/source/developing/building_the_docs.rst
@@ -55,7 +55,7 @@
``cosmological_analysis.rst``, etc.), and add some description of what the script
actually does. We recommend that you use one of the
`sample data sets <http://yt-project.org/data>`_ in your recipe. When the full
-docs are built, each of the cookbook recipes are executed dynamically on
+docs are built, each of the cookbook recipes is executed dynamically on
a system which has access to all of the sample datasets. Any output images
generated by your script will then be attached inline in the built documentation
directly following your script.
@@ -99,7 +99,7 @@
Building the entire set of yt documentation is a laborious task, since you
need to have a large number of packages in order to successfully execute
and render all of the notebooks and yt recipes drawing from every corner
-of the yt source. As an quick alternative, one can do a ``quick`` build
+of the yt source. As a quick alternative, one can do a ``quick`` build
of the documentation, which eschews the need for downloading all of these
dependencies, but it only produces the static docs. The static docs do
not include the cookbook outputs and the notebooks, but this is good
https://bitbucket.org/yt_analysis/yt/commits/f67f7a6b68f7/
Changeset: f67f7a6b68f7
User: qobilidop
Date: 2017-07-04 18:21:22+00:00
Summary: Fix a typo
Affected #: 1 file
diff -r 04e0af143dc8b174f6a8339581fa5d94cd39ce2a -r f67f7a6b68f701302828e039dd3a5bcf0da0f2cd doc/source/developing/building_the_docs.rst
--- a/doc/source/developing/building_the_docs.rst
+++ b/doc/source/developing/building_the_docs.rst
@@ -12,8 +12,8 @@
for increasing yt's impact in the community. It is the way in which the
world will understand how to use our code, so it needs to be done concisely
and understandably. Typically, when a developer submits some piece of code
-with new functionality, she should also include documentation on how to use
-that functionality (as per :ref:`requirements-for-code-submission`).
+with new functionality, the developer should also include documentation on how
+to use that functionality (as per :ref:`requirements-for-code-submission`).
Depending on the nature of the code addition, this could be a new narrative
docs section describing how the new code works and how to use it, it could
include a recipe in the cookbook section, or it could simply be adding a note
https://bitbucket.org/yt_analysis/yt/commits/4e7c0ad7b5a3/
Changeset: 4e7c0ad7b5a3
User: qobilidop
Date: 2017-07-04 18:35:22+00:00
Summary: Proper capitalization
I checked "Python", "Sphinx" and "Sphinx Bootstrap Theme" and capitalized them the proper way. This might also be worth doing in a larger scope. But for now, just consider this one page.
Affected #: 1 file
diff -r f67f7a6b68f701302828e039dd3a5bcf0da0f2cd -r 4e7c0ad7b5a34b524a38064356f7cea2d42172d5 doc/source/developing/building_the_docs.rst
--- a/doc/source/developing/building_the_docs.rst
+++ b/doc/source/developing/building_the_docs.rst
@@ -47,7 +47,7 @@
New cookbook recipes (see :ref:`cookbook`) are very helpful for the community
as they provide simple annotated recipes on how to use specific functionality.
-To add one, create a concise python script which demonstrates some
+To add one, create a concise Python script which demonstrates some
functionality and pare it down to its minimum. Add some comment lines to
describe what it is that you're doing along the way. Place this ``.py`` file
in the ``source/cookbook/`` directory, and then link to it explicitly in one
@@ -75,17 +75,17 @@
Building the Documentation
--------------------------
-The yt documentation makes heavy use of the sphinx documentation automation
-suite. Sphinx, written in python, was originally created for the documentation
-of the python project and has many nice capabilities for managing the
-documentation of python code.
+The yt documentation makes heavy use of the Sphinx documentation automation
+suite. Sphinx, written in Python, was originally created for the documentation
+of the Python project and has many nice capabilities for managing the
+documentation of Python code.
While much of the yt documentation is static text, we make heavy use of
cross-referencing with API documentation that is automatically generated at
-build time by sphinx. We also use sphinx to run code snippets (e.g. the
+build time by Sphinx. We also use Sphinx to run code snippets (e.g. the
cookbook and the notebooks) and embed resulting images and example data.
-You will want to make sure you have both Sphinx and the sphinx bootstrap theme
+You will want to make sure you have both Sphinx and the Sphinx Bootstrap Theme
installed. This installation is easily performed by running this at the
command line:
@@ -120,7 +120,7 @@
`Bootstrap theme <https://pypi.python.org/pypi/sphinx-bootstrap-theme/>`_,
which can be installed via ``pip install sphinx_bootstrap_theme``.
-In order to tell sphinx not to do all of the dynamical building, you must
+In order to tell Sphinx not to do all of the dynamical building, you must
set the ``$READTHEDOCS`` environment variable to be True by typing this at
the command line:
@@ -132,7 +132,7 @@
This variable is set for automated builds on the free ReadTheDocs service but
can be used by anyone to force a quick, minimal build.
-Now all you need to do is execute sphinx on the yt doc source. Go to the
+Now all you need to do is execute Sphinx on the yt doc source. Go to the
documentation directory and build the docs:
.. code-block:: bash
@@ -150,8 +150,8 @@
As alluded to earlier, building the full documentation is a bit more involved
than simply building the static documentation.
-The full documentation makes heavy use of custom sphinx extensions to transform
-recipes, notebooks, and inline code snippets into python scripts, IPython_
+The full documentation makes heavy use of custom Sphinx extensions to transform
+recipes, notebooks, and inline code snippets into Python scripts, IPython_
notebooks, or notebook cells that are executed when the docs are built.
To do this, we use Jupyter's nbconvert module to transform notebooks into
@@ -188,7 +188,7 @@
configuration.
Now that you have everything set up properly, go to the documentation directory
-and build it using sphinx:
+and build it using Sphinx:
.. code-block:: bash
@@ -207,18 +207,18 @@
Building the Docs (Hybrid)
^^^^^^^^^^^^^^^^^^^^^^^^^^
-It's also possible to create a custom sphinx build that builds a restricted set
+It's also possible to create a custom Sphinx build that builds a restricted set
of notebooks or scripts. This can be accomplished by editing the Sphinx
:code:`conf.py` file included in the :code:`source` directory at the top level
of the docs. The extensions included in the build are contained in the
:code:`extensions` list. To disable an extension, simply remove it from the
-list. Doing so will raise a warning when sphinx encounters the directive in the
-docs and will prevent sphinx from evaluating the directive.
+list. Doing so will raise a warning when Sphinx encounters the directive in the
+docs and will prevent Sphinx from evaluating the directive.
As a concrete example, if one wanted to include the :code:`notebook`, and
:code:`notebook-cell` directives, but not the :code:`python-script` or
:code:`autosummary` directives, one would just need to comment out the lines
that append these extensions to the :code:`extensions` list. The resulting docs
build will be significantly quicker since it would avoid executing the lengthy
-API autodocumentation as well as a large number of python script snippets in
+API autodocumentation as well as a large number of Python script snippets in
the narrative docs.
https://bitbucket.org/yt_analysis/yt/commits/2464a3bc4448/
Changeset: 2464a3bc4448
User: qobilidop
Date: 2017-07-05 20:31:18+00:00
Summary: Change "dynamical build" to "dynamic build"
Takes @brittonsmith's advice.
Affected #: 1 file
diff -r 4e7c0ad7b5a34b524a38064356f7cea2d42172d5 -r 2464a3bc44489914887aaf3d5ec9285c2856a5c4 doc/source/developing/building_the_docs.rst
--- a/doc/source/developing/building_the_docs.rst
+++ b/doc/source/developing/building_the_docs.rst
@@ -63,8 +63,8 @@
After you have made your modifications to the docs, you will want to make sure
that they render the way you expect them to render. For more information on
this, see the section on :ref:`docs_build`. Unless you're contributing cookbook
-recipes or notebooks which require a dynamical build, you can probably get
-away with just doing a 'quick' docs build.
+recipes or notebooks which require a dynamic build, you can probably get away
+with just doing a 'quick' docs build.
When you have completed your documentation additions, commit your changes
to your repository and make a pull request in the same way you would contribute
@@ -120,9 +120,9 @@
`Bootstrap theme <https://pypi.python.org/pypi/sphinx-bootstrap-theme/>`_,
which can be installed via ``pip install sphinx_bootstrap_theme``.
-In order to tell Sphinx not to do all of the dynamical building, you must
-set the ``$READTHEDOCS`` environment variable to be True by typing this at
-the command line:
+In order to tell Sphinx not to do all of the dynamic building, you must set the
+``$READTHEDOCS`` environment variable to be True by typing this at the command
+line:
.. code-block:: bash
https://bitbucket.org/yt_analysis/yt/commits/6e1264f48f80/
Changeset: 6e1264f48f80
User: ngoldbaum
Date: 2017-07-05 20:36:11+00:00
Summary: Merge pull request #1478 from qobilidop/improve-building_the_docs
Improve the documentation page Documentation
Affected #: 1 file
diff -r 62b7d0b5dfd121aa80589cf574b499d3ddca4782 -r 6e1264f48f8060e56cbaab4a367d7dd67e803485 doc/source/developing/building_the_docs.rst
--- a/doc/source/developing/building_the_docs.rst
+++ b/doc/source/developing/building_the_docs.rst
@@ -12,8 +12,8 @@
for increasing yt's impact in the community. It is the way in which the
world will understand how to use our code, so it needs to be done concisely
and understandably. Typically, when a developer submits some piece of code
-with new functionality, she should also include documentation on how to use
-that functionality (as per :ref:`requirements-for-code-submission`).
+with new functionality, the developer should also include documentation on how
+to use that functionality (as per :ref:`requirements-for-code-submission`).
Depending on the nature of the code addition, this could be a new narrative
docs section describing how the new code works and how to use it, it could
include a recipe in the cookbook section, or it could simply be adding a note
@@ -47,7 +47,7 @@
New cookbook recipes (see :ref:`cookbook`) are very helpful for the community
as they provide simple annotated recipes on how to use specific functionality.
-To add one, create a concise python script which demonstrates some
+To add one, create a concise Python script which demonstrates some
functionality and pare it down to its minimum. Add some comment lines to
describe what it is that you're doing along the way. Place this ``.py`` file
in the ``source/cookbook/`` directory, and then link to it explicitly in one
@@ -55,7 +55,7 @@
``cosmological_analysis.rst``, etc.), and add some description of what the script
actually does. We recommend that you use one of the
`sample data sets <http://yt-project.org/data>`_ in your recipe. When the full
-docs are built, each of the cookbook recipes are executed dynamically on
+docs are built, each of the cookbook recipes is executed dynamically on
a system which has access to all of the sample datasets. Any output images
generated by your script will then be attached inline in the built documentation
directly following your script.
@@ -63,8 +63,8 @@
After you have made your modifications to the docs, you will want to make sure
that they render the way you expect them to render. For more information on
this, see the section on :ref:`docs_build`. Unless you're contributing cookbook
-recipes or notebooks which require a dynamical build, you can probably get
-away with just doing a 'quick' docs build.
+recipes or notebooks which require a dynamic build, you can probably get away
+with just doing a 'quick' docs build.
When you have completed your documentation additions, commit your changes
to your repository and make a pull request in the same way you would contribute
@@ -75,17 +75,17 @@
Building the Documentation
--------------------------
-The yt documentation makes heavy use of the sphinx documentation automation
-suite. Sphinx, written in python, was originally created for the documentation
-of the python project and has many nice capabilities for managing the
-documentation of python code.
+The yt documentation makes heavy use of the Sphinx documentation automation
+suite. Sphinx, written in Python, was originally created for the documentation
+of the Python project and has many nice capabilities for managing the
+documentation of Python code.
While much of the yt documentation is static text, we make heavy use of
cross-referencing with API documentation that is automatically generated at
-build time by sphinx. We also use sphinx to run code snippets (e.g. the
+build time by Sphinx. We also use Sphinx to run code snippets (e.g. the
cookbook and the notebooks) and embed resulting images and example data.
-You will want to make sure you have both Sphinx and the sphinx bootstrap theme
+You will want to make sure you have both Sphinx and the Sphinx Bootstrap Theme
installed. This installation is easily performed by running this at the
command line:
@@ -99,7 +99,7 @@
Building the entire set of yt documentation is a laborious task, since you
need to have a large number of packages in order to successfully execute
and render all of the notebooks and yt recipes drawing from every corner
-of the yt source. As an quick alternative, one can do a ``quick`` build
+of the yt source. As a quick alternative, one can do a ``quick`` build
of the documentation, which eschews the need for downloading all of these
dependencies, but it only produces the static docs. The static docs do
not include the cookbook outputs and the notebooks, but this is good
@@ -120,9 +120,9 @@
`Bootstrap theme <https://pypi.python.org/pypi/sphinx-bootstrap-theme/>`_,
which can be installed via ``pip install sphinx_bootstrap_theme``.
-In order to tell sphinx not to do all of the dynamical building, you must
-set the ``$READTHEDOCS`` environment variable to be True by typing this at
-the command line:
+In order to tell Sphinx not to do all of the dynamic building, you must set the
+``$READTHEDOCS`` environment variable to be True by typing this at the command
+line:
.. code-block:: bash
@@ -132,16 +132,16 @@
This variable is set for automated builds on the free ReadTheDocs service but
can be used by anyone to force a quick, minimal build.
-Now all you need to do is execute sphinx on the yt doc source. Go to the
+Now all you need to do is execute Sphinx on the yt doc source. Go to the
documentation directory and build the docs:
.. code-block:: bash
- cd $YT_HG/doc
+ cd $YT_GIT/doc
make html
This will produce an html version of the documentation locally in the
-``$YT_HG/doc/build/html`` directory. You can now go there and open
+``$YT_GIT/doc/build/html`` directory. You can now go there and open
up ``index.html`` or whatever file you wish in your web browser.
Building the Docs (Full)
@@ -150,8 +150,8 @@
As alluded to earlier, building the full documentation is a bit more involved
than simply building the static documentation.
-The full documentation makes heavy use of custom sphinx extensions to transform
-recipes, notebooks, and inline code snippets into python scripts, IPython_
+The full documentation makes heavy use of custom Sphinx extensions to transform
+recipes, notebooks, and inline code snippets into Python scripts, IPython_
notebooks, or notebook cells that are executed when the docs are built.
To do this, we use Jupyter's nbconvert module to transform notebooks into
@@ -188,11 +188,11 @@
configuration.
Now that you have everything set up properly, go to the documentation directory
-and build it using sphinx:
+and build it using Sphinx:
.. code-block:: bash
- cd $YT_HG/doc
+ cd $YT_GIT/doc
make html
If all of the dependencies are installed and all of the test data is in the
@@ -207,18 +207,18 @@
Building the Docs (Hybrid)
^^^^^^^^^^^^^^^^^^^^^^^^^^
-It's also possible to create a custom sphinx build that builds a restricted set
+It's also possible to create a custom Sphinx build that builds a restricted set
of notebooks or scripts. This can be accomplished by editing the Sphinx
:code:`conf.py` file included in the :code:`source` directory at the top level
of the docs. The extensions included in the build are contained in the
:code:`extensions` list. To disable an extension, simply remove it from the
-list. Doing so will raise a warning when sphinx encounters the directive in the
-docs and will prevent sphinx from evaluating the directive.
+list. Doing so will raise a warning when Sphinx encounters the directive in the
+docs and will prevent Sphinx from evaluating the directive.
As a concrete example, if one wanted to include the :code:`notebook`, and
:code:`notebook-cell` directives, but not the :code:`python-script` or
:code:`autosummary` directives, one would just need to comment out the lines
that append these extensions to the :code:`extensions` list. The resulting docs
build will be significantly quicker since it would avoid executing the lengthy
-API autodocumentation as well as a large number of python script snippets in
+API autodocumentation as well as a large number of Python script snippets in
the narrative docs.
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