[yt-svn] commit/yt-doc: 2 new changesets
Bitbucket
commits-noreply at bitbucket.org
Thu Jul 12 08:42:51 PDT 2012
2 new commits in yt-doc:
https://bitbucket.org/yt_analysis/yt-doc/changeset/50dee20c36b0/
changeset: 50dee20c36b0
user: samskillman
date: 2012-07-10 22:29:07
summary: Moving to a flat TOC on the front page of the docs, and moving API down one level to hide all the functions from the front page. Also added links to previous builds of the docs in the changelog, which I'm happy to take back out.
affected #: 5 files
diff -r 64ad5aeaa3dca9aa0ee05e50661aebbe07d53374 -r 50dee20c36b0ff0080455c4308823af894135f30 source/api.rst
--- a/source/api.rst
+++ /dev/null
@@ -1,402 +0,0 @@
-Plots and the Plotting Interface
-================================
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.visualization.plot_collection.PlotCollection
- ~yt.visualization.plot_collection.PlotCollectionInteractive
- ~yt.visualization.plot_types.SlicePlot
- ~yt.visualization.plot_types.ProjectionPlot
- ~yt.visualization.plot_types.PhasePlot
- ~yt.visualization.plot_types.Profile1DPlot
- ~yt.visualization.fixed_resolution.FixedResolutionBuffer
- ~yt.visualization.fixed_resolution.ObliqueFixedResolutionBuffer
- ~yt.visualization.profile_plotter.PhasePlotter
- ~yt.visualization.plot_collection.get_multi_plot
-
-Data Sources
-============
-
-.. _physical-object-api:
-
-Physical Objects
-----------------
-
-These are the objects that act as physical selections of data, describing a
-region in space. These are not typically addressed directly; see
-:ref:`available-objects` for more information.
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.data_objects.data_containers.AMRData
- ~yt.data_objects.data_containers.AMR1DData
- ~yt.data_objects.data_containers.AMR2DData
- ~yt.data_objects.data_containers.AMR3DData
- ~yt.data_objects.data_containers.AMRCoveringGridBase
- ~yt.data_objects.data_containers.AMRCuttingPlaneBase
- ~yt.data_objects.data_containers.AMRCylinderBase
- ~yt.data_objects.data_containers.AMRGridCollectionBase
- ~yt.data_objects.data_containers.AMRRayBase
- ~yt.data_objects.data_containers.AMROrthoRayBase
- ~yt.data_objects.data_containers.AMRStreamlineBase
- ~yt.data_objects.data_containers.AMRProjBase
- ~yt.data_objects.data_containers.AMRRegionBase
- ~yt.data_objects.data_containers.AMRSliceBase
- ~yt.data_objects.data_containers.AMRSmoothedCoveringGridBase
- ~yt.data_objects.data_containers.AMRSphereBase
-
-Time Series Objects
--------------------
-
-These are objects that either contain and represent or operate on series of
-datasets.
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.data_objects.time_series.TimeSeriesData
- ~yt.data_objects.time_series.TimeSeriesDataObject
- ~yt.data_objects.time_series.TimeSeriesQuantitiesContainer
- ~yt.data_objects.time_series.AnalysisTaskProxy
-
-Frontends
----------
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.data_objects.grid_patch.AMRGridPatch
- ~yt.data_objects.hierarchy.AMRHierarchy
- ~yt.data_objects.static_output.StaticOutput
-
-Enzo
-++++
-
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.frontends.enzo.data_structures.EnzoGrid
- ~yt.frontends.enzo.data_structures.EnzoHierarchy
- ~yt.frontends.enzo.data_structures.EnzoStaticOutput
-
-Orion
-+++++
-
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.frontends.orion.data_structures.OrionGrid
- ~yt.frontends.orion.data_structures.OrionHierarchy
- ~yt.frontends.orion.data_structures.OrionStaticOutput
-
-FLASH
-+++++
-
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.frontends.flash.data_structures.FLASHGrid
- ~yt.frontends.flash.data_structures.FLASHHierarchy
- ~yt.frontends.flash.data_structures.FLASHStaticOutput
-
-Chombo
-++++++
-
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.frontends.chombo.data_structures.ChomboGrid
- ~yt.frontends.chombo.data_structures.ChomboHierarchy
- ~yt.frontends.chombo.data_structures.ChomboStaticOutput
-
-RAMSES
-++++++
-
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.frontends.ramses.data_structures.RAMSESGrid
- ~yt.frontends.ramses.data_structures.RAMSESHierarchy
- ~yt.frontends.ramses.data_structures.RAMSESStaticOutput
-
-Derived Datatypes
-=================
-
-Profiles and Histograms
------------------------
-
-These types are used to sum data up and either return that sum or return an
-average. Typically they are more easily used through the
-`yt.visualization.plot_collection` interface.
-
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.data_objects.profiles.BinnedProfile1D
- ~yt.data_objects.profiles.BinnedProfile2D
- ~yt.data_objects.profiles.BinnedProfile3D
-
-Halo Finding and Particle Functions
------------------------------------
-
-Halo finding can be executed using these types.
-
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.analysis_modules.halo_finding.halo_objects.FOFHaloFinder
- ~yt.analysis_modules.halo_finding.halo_objects.HOPHaloFinder
- ~yt.analysis_modules.halo_finding.halo_objects.Halo
- ~yt.analysis_modules.halo_finding.halo_objects.HaloList
-
-Two Point Functions
--------------------
-
-These functions are designed to create correlations or other results of
-operations acting on two spatially-distinct points in a data source. See also
-:ref:`two_point_functions`.
-
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.analysis_modules.api.TwoPointFunctions
- ~yt.analysis_modules.api.FcnSet
-
-Field Types
-===========
-
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.data_objects.field_info_container.DerivedField
- ~yt.data_objects.field_info_container.FieldInfoContainer
- ~yt.data_objects.field_info_container.ValidateDataField
- ~yt.data_objects.field_info_container.ValidateGridType
- ~yt.data_objects.field_info_container.ValidateParameter
- ~yt.data_objects.field_info_container.ValidateProperty
- ~yt.data_objects.field_info_container.ValidateSpatial
-
-Extension Types
-===============
-
-Coordinate Transformations
---------------------------
-
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.analysis_modules.coordinate_transformation.transforms.arbitrary_regrid
- ~yt.analysis_modules.coordinate_transformation.transforms.spherical_regrid
-
-Cosmology and Star Particle Analysis
-------------------------------------
-
-For the generation of stellar SEDs. (See also :ref:`star_analysis`.)
-
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.analysis_modules.star_analysis.sfr_spectrum.StarFormationRate
- ~yt.analysis_modules.star_analysis.sfr_spectrum.SpectrumBuilder
-
-Light cone generation and simulation analysis. (See also
-:ref:`light-cone-generator`.)
-
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.analysis_modules.light_cone.light_cone.LightCone
-
-Volume Rendering
-----------------
-
-See also :ref:`volume_rendering`.
-
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.visualization.volume_rendering.camera.Camera
- ~yt.visualization.volume_rendering.camera.off_axis_projection
- ~yt.visualization.volume_rendering.transfer_functions.ColorTransferFunction
- ~yt.visualization.volume_rendering.grid_partitioner.HomogenizedVolume
- ~yt.visualization.volume_rendering.transfer_functions.MultiVariateTransferFunction
- ~yt.utilities.amr_utils.PartitionedGrid
- ~yt.utilities.amr_kdtree.amr_kdtree.AMRKDTree
- ~yt.visualization.volume_rendering.camera.PerspectiveCamera
- ~yt.visualization.volume_rendering.transfer_functions.PlanckTransferFunction
- ~yt.visualization.volume_rendering.transfer_functions.ProjectionTransferFunction
- ~yt.visualization.volume_rendering.camera.StereoPairCamera
- ~yt.visualization.volume_rendering.transfer_functions.TransferFunction
-
-.. _image_writer:
-
-Streamlining
-------------
-
-See also :ref:`streamlines`.
-
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.visualization.streamlines.Streamlines
-
-Image Writing
--------------
-
-These functions are all used for fast writing of images directly to disk,
-without calling matplotlib. This can be very useful for high-cadence outputs
-where colorbars are unnecessary or for volume rendering.
-
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.visualization.image_writer.multi_image_composite
- ~yt.visualization.image_writer.write_bitmap
- ~yt.visualization.image_writer.write_image
- ~yt.visualization.image_writer.map_to_colors
- ~yt.visualization.image_writer.strip_colormap_data
- ~yt.visualization.image_writer.splat_points
- ~yt.visualization.image_writer.annotate_image
-
-We also provide a module that is very good for generating EPS figures,
-particularly with complicated layouts.
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.visualization.eps_writer.DualEPS
- ~yt.visualization.eps_writer.single_plot
- ~yt.visualization.eps_writer.multiplot
- ~yt.visualization.eps_writer.multiplot_yt
- ~yt.visualization.eps_writer.return_cmap
-
-.. _image-panner-api:
-
-Image Panning and Scanning
---------------------------
-
-See also :ref:`image-panner`.
-
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.visualization.image_panner.vm_panner.VariableMeshPanner
- ~yt.visualization.image_panner.vm_panner.WindowedVariableMeshPanner
- ~yt.visualization.image_panner.vm_panner.MultipleWindowVariableMeshPanner
- ~yt.visualization.image_panner.vm_panner.ImageSaver
-
-Derived Quantities
-==================
-
-See :ref:`derived-quantities`.
-
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.data_objects.derived_quantities._AngularMomentumVector
- ~yt.data_objects.derived_quantities._BaryonSpinParameter
- ~yt.data_objects.derived_quantities._BulkVelocity
- ~yt.data_objects.derived_quantities._CenterOfMass
- ~yt.data_objects.derived_quantities._Extrema
- ~yt.data_objects.derived_quantities._IsBound
- ~yt.data_objects.derived_quantities._MaxLocation
- ~yt.data_objects.derived_quantities._ParticleSpinParameter
- ~yt.data_objects.derived_quantities._TotalMass
- ~yt.data_objects.derived_quantities._TotalQuantity
- ~yt.data_objects.derived_quantities._WeightedAverageQuantity
-
-.. _callback-api:
-
-Callback List
-=============
-
-
-See also :ref:`callbacks`.
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.visualization.plot_modifications.ArrowCallback
- ~yt.visualization.plot_modifications.ClumpContourCallback
- ~yt.visualization.plot_modifications.ContourCallback
- ~yt.visualization.plot_modifications.CoordAxesCallback
- ~yt.visualization.plot_modifications.CuttingQuiverCallback
- ~yt.visualization.plot_modifications.GridBoundaryCallback
- ~yt.visualization.plot_modifications.HopCircleCallback
- ~yt.visualization.plot_modifications.HopParticleCallback
- ~yt.visualization.plot_modifications.LabelCallback
- ~yt.visualization.plot_modifications.LinePlotCallback
- ~yt.visualization.plot_modifications.MarkerAnnotateCallback
- ~yt.visualization.plot_modifications.ParticleCallback
- ~yt.visualization.plot_modifications.PointAnnotateCallback
- ~yt.visualization.plot_modifications.QuiverCallback
- ~yt.visualization.plot_modifications.SphereCallback
- ~yt.visualization.plot_modifications.TextLabelCallback
- ~yt.visualization.plot_modifications.TitleCallback
- ~yt.visualization.plot_modifications.UnitBoundaryCallback
- ~yt.visualization.plot_modifications.VelocityCallback
- ~yt.visualization.plot_modifications.VobozCircleCallback
-
-Function List
-=============
-
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.convenience.load
- ~yt.funcs.deprecate
- ~yt.funcs.ensure_list
- ~yt.funcs.get_pbar
- ~yt.funcs.humanize_time
- ~yt.funcs.insert_ipython
- ~yt.funcs.iterable
- ~yt.funcs.just_one
- ~yt.funcs.only_on_root
- ~yt.funcs.paste_traceback
- ~yt.funcs.pdb_run
- ~yt.funcs.print_tb
- ~yt.funcs.rootonly
- ~yt.funcs.time_execution
- ~yt.analysis_modules.level_sets.contour_finder.identify_contours
- ~yt.utilities.parallel_tools.parallel_analysis_interface.parallel_blocking_call
- ~yt.utilities.parallel_tools.parallel_analysis_interface.parallel_passthrough
- ~yt.utilities.parallel_tools.parallel_analysis_interface.parallel_root_only
- ~yt.utilities.parallel_tools.parallel_analysis_interface.parallel_simple_proxy
- ~yt.utilities.parallel_tools.parallel_analysis_interface.parallel_splitter
-
-Miscellaneous Types
-===================
-
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.config.YTConfigParser
- ~yt.analysis_modules.hierarchy_subset.hierarchy_subset.ConstructedRootGrid
- ~yt.analysis_modules.hierarchy_subset.hierarchy_subset.ExtractedHierarchy
- ~yt.analysis_modules.spectral_integrator.spectral_frequency_integrator.SpectralFrequencyIntegrator
- ~yt.utilities.parameter_file_storage.ParameterFileStore
- ~yt.data_objects.data_containers.FakeGridForParticles
- ~yt.utilities.parallel_tools.parallel_analysis_interface.ObjectIterator
- ~yt.utilities.parallel_tools.parallel_analysis_interface.ParallelAnalysisInterface
- ~yt.utilities.parallel_tools.parallel_analysis_interface.ParallelObjectIterator
diff -r 64ad5aeaa3dca9aa0ee05e50661aebbe07d53374 -r 50dee20c36b0ff0080455c4308823af894135f30 source/api/api.rst
--- /dev/null
+++ b/source/api/api.rst
@@ -0,0 +1,402 @@
+Plots and the Plotting Interface
+================================
+
+.. autosummary::
+ :toctree: generated/
+
+ ~yt.visualization.plot_collection.PlotCollection
+ ~yt.visualization.plot_collection.PlotCollectionInteractive
+ ~yt.visualization.plot_types.SlicePlot
+ ~yt.visualization.plot_types.ProjectionPlot
+ ~yt.visualization.plot_types.PhasePlot
+ ~yt.visualization.plot_types.Profile1DPlot
+ ~yt.visualization.fixed_resolution.FixedResolutionBuffer
+ ~yt.visualization.fixed_resolution.ObliqueFixedResolutionBuffer
+ ~yt.visualization.profile_plotter.PhasePlotter
+ ~yt.visualization.plot_collection.get_multi_plot
+
+Data Sources
+============
+
+.. _physical-object-api:
+
+Physical Objects
+----------------
+
+These are the objects that act as physical selections of data, describing a
+region in space. These are not typically addressed directly; see
+:ref:`available-objects` for more information.
+
+.. autosummary::
+ :toctree: generated/
+
+ ~yt.data_objects.data_containers.AMRData
+ ~yt.data_objects.data_containers.AMR1DData
+ ~yt.data_objects.data_containers.AMR2DData
+ ~yt.data_objects.data_containers.AMR3DData
+ ~yt.data_objects.data_containers.AMRCoveringGridBase
+ ~yt.data_objects.data_containers.AMRCuttingPlaneBase
+ ~yt.data_objects.data_containers.AMRCylinderBase
+ ~yt.data_objects.data_containers.AMRGridCollectionBase
+ ~yt.data_objects.data_containers.AMRRayBase
+ ~yt.data_objects.data_containers.AMROrthoRayBase
+ ~yt.data_objects.data_containers.AMRStreamlineBase
+ ~yt.data_objects.data_containers.AMRProjBase
+ ~yt.data_objects.data_containers.AMRRegionBase
+ ~yt.data_objects.data_containers.AMRSliceBase
+ ~yt.data_objects.data_containers.AMRSmoothedCoveringGridBase
+ ~yt.data_objects.data_containers.AMRSphereBase
+
+Time Series Objects
+-------------------
+
+These are objects that either contain and represent or operate on series of
+datasets.
+
+.. autosummary::
+ :toctree: generated/
+
+ ~yt.data_objects.time_series.TimeSeriesData
+ ~yt.data_objects.time_series.TimeSeriesDataObject
+ ~yt.data_objects.time_series.TimeSeriesQuantitiesContainer
+ ~yt.data_objects.time_series.AnalysisTaskProxy
+
+Frontends
+---------
+
+.. autosummary::
+ :toctree: generated/
+
+ ~yt.data_objects.grid_patch.AMRGridPatch
+ ~yt.data_objects.hierarchy.AMRHierarchy
+ ~yt.data_objects.static_output.StaticOutput
+
+Enzo
+++++
+
+
+.. autosummary::
+ :toctree: generated/
+
+ ~yt.frontends.enzo.data_structures.EnzoGrid
+ ~yt.frontends.enzo.data_structures.EnzoHierarchy
+ ~yt.frontends.enzo.data_structures.EnzoStaticOutput
+
+Orion
++++++
+
+
+.. autosummary::
+ :toctree: generated/
+
+ ~yt.frontends.orion.data_structures.OrionGrid
+ ~yt.frontends.orion.data_structures.OrionHierarchy
+ ~yt.frontends.orion.data_structures.OrionStaticOutput
+
+FLASH
++++++
+
+
+.. autosummary::
+ :toctree: generated/
+
+ ~yt.frontends.flash.data_structures.FLASHGrid
+ ~yt.frontends.flash.data_structures.FLASHHierarchy
+ ~yt.frontends.flash.data_structures.FLASHStaticOutput
+
+Chombo
+++++++
+
+
+.. autosummary::
+ :toctree: generated/
+
+ ~yt.frontends.chombo.data_structures.ChomboGrid
+ ~yt.frontends.chombo.data_structures.ChomboHierarchy
+ ~yt.frontends.chombo.data_structures.ChomboStaticOutput
+
+RAMSES
+++++++
+
+
+.. autosummary::
+ :toctree: generated/
+
+ ~yt.frontends.ramses.data_structures.RAMSESGrid
+ ~yt.frontends.ramses.data_structures.RAMSESHierarchy
+ ~yt.frontends.ramses.data_structures.RAMSESStaticOutput
+
+Derived Datatypes
+=================
+
+Profiles and Histograms
+-----------------------
+
+These types are used to sum data up and either return that sum or return an
+average. Typically they are more easily used through the
+`yt.visualization.plot_collection` interface.
+
+
+.. autosummary::
+ :toctree: generated/
+
+ ~yt.data_objects.profiles.BinnedProfile1D
+ ~yt.data_objects.profiles.BinnedProfile2D
+ ~yt.data_objects.profiles.BinnedProfile3D
+
+Halo Finding and Particle Functions
+-----------------------------------
+
+Halo finding can be executed using these types.
+
+
+.. autosummary::
+ :toctree: generated/
+
+ ~yt.analysis_modules.halo_finding.halo_objects.FOFHaloFinder
+ ~yt.analysis_modules.halo_finding.halo_objects.HOPHaloFinder
+ ~yt.analysis_modules.halo_finding.halo_objects.Halo
+ ~yt.analysis_modules.halo_finding.halo_objects.HaloList
+
+Two Point Functions
+-------------------
+
+These functions are designed to create correlations or other results of
+operations acting on two spatially-distinct points in a data source. See also
+:ref:`two_point_functions`.
+
+
+.. autosummary::
+ :toctree: generated/
+
+ ~yt.analysis_modules.api.TwoPointFunctions
+ ~yt.analysis_modules.api.FcnSet
+
+Field Types
+===========
+
+
+.. autosummary::
+ :toctree: generated/
+
+ ~yt.data_objects.field_info_container.DerivedField
+ ~yt.data_objects.field_info_container.FieldInfoContainer
+ ~yt.data_objects.field_info_container.ValidateDataField
+ ~yt.data_objects.field_info_container.ValidateGridType
+ ~yt.data_objects.field_info_container.ValidateParameter
+ ~yt.data_objects.field_info_container.ValidateProperty
+ ~yt.data_objects.field_info_container.ValidateSpatial
+
+Extension Types
+===============
+
+Coordinate Transformations
+--------------------------
+
+
+.. autosummary::
+ :toctree: generated/
+
+ ~yt.analysis_modules.coordinate_transformation.transforms.arbitrary_regrid
+ ~yt.analysis_modules.coordinate_transformation.transforms.spherical_regrid
+
+Cosmology and Star Particle Analysis
+------------------------------------
+
+For the generation of stellar SEDs. (See also :ref:`star_analysis`.)
+
+
+.. autosummary::
+ :toctree: generated/
+
+ ~yt.analysis_modules.star_analysis.sfr_spectrum.StarFormationRate
+ ~yt.analysis_modules.star_analysis.sfr_spectrum.SpectrumBuilder
+
+Light cone generation and simulation analysis. (See also
+:ref:`light-cone-generator`.)
+
+
+.. autosummary::
+ :toctree: generated/
+
+ ~yt.analysis_modules.light_cone.light_cone.LightCone
+
+Volume Rendering
+----------------
+
+See also :ref:`volume_rendering`.
+
+
+.. autosummary::
+ :toctree: generated/
+
+ ~yt.visualization.volume_rendering.camera.Camera
+ ~yt.visualization.volume_rendering.camera.off_axis_projection
+ ~yt.visualization.volume_rendering.transfer_functions.ColorTransferFunction
+ ~yt.visualization.volume_rendering.grid_partitioner.HomogenizedVolume
+ ~yt.visualization.volume_rendering.transfer_functions.MultiVariateTransferFunction
+ ~yt.utilities.amr_utils.PartitionedGrid
+ ~yt.utilities.amr_kdtree.amr_kdtree.AMRKDTree
+ ~yt.visualization.volume_rendering.camera.PerspectiveCamera
+ ~yt.visualization.volume_rendering.transfer_functions.PlanckTransferFunction
+ ~yt.visualization.volume_rendering.transfer_functions.ProjectionTransferFunction
+ ~yt.visualization.volume_rendering.camera.StereoPairCamera
+ ~yt.visualization.volume_rendering.transfer_functions.TransferFunction
+
+.. _image_writer:
+
+Streamlining
+------------
+
+See also :ref:`streamlines`.
+
+
+.. autosummary::
+ :toctree: generated/
+
+ ~yt.visualization.streamlines.Streamlines
+
+Image Writing
+-------------
+
+These functions are all used for fast writing of images directly to disk,
+without calling matplotlib. This can be very useful for high-cadence outputs
+where colorbars are unnecessary or for volume rendering.
+
+
+.. autosummary::
+ :toctree: generated/
+
+ ~yt.visualization.image_writer.multi_image_composite
+ ~yt.visualization.image_writer.write_bitmap
+ ~yt.visualization.image_writer.write_image
+ ~yt.visualization.image_writer.map_to_colors
+ ~yt.visualization.image_writer.strip_colormap_data
+ ~yt.visualization.image_writer.splat_points
+ ~yt.visualization.image_writer.annotate_image
+
+We also provide a module that is very good for generating EPS figures,
+particularly with complicated layouts.
+
+.. autosummary::
+ :toctree: generated/
+
+ ~yt.visualization.eps_writer.DualEPS
+ ~yt.visualization.eps_writer.single_plot
+ ~yt.visualization.eps_writer.multiplot
+ ~yt.visualization.eps_writer.multiplot_yt
+ ~yt.visualization.eps_writer.return_cmap
+
+.. _image-panner-api:
+
+Image Panning and Scanning
+--------------------------
+
+See also :ref:`image-panner`.
+
+
+.. autosummary::
+ :toctree: generated/
+
+ ~yt.visualization.image_panner.vm_panner.VariableMeshPanner
+ ~yt.visualization.image_panner.vm_panner.WindowedVariableMeshPanner
+ ~yt.visualization.image_panner.vm_panner.MultipleWindowVariableMeshPanner
+ ~yt.visualization.image_panner.vm_panner.ImageSaver
+
+Derived Quantities
+==================
+
+See :ref:`derived-quantities`.
+
+
+.. autosummary::
+ :toctree: generated/
+
+ ~yt.data_objects.derived_quantities._AngularMomentumVector
+ ~yt.data_objects.derived_quantities._BaryonSpinParameter
+ ~yt.data_objects.derived_quantities._BulkVelocity
+ ~yt.data_objects.derived_quantities._CenterOfMass
+ ~yt.data_objects.derived_quantities._Extrema
+ ~yt.data_objects.derived_quantities._IsBound
+ ~yt.data_objects.derived_quantities._MaxLocation
+ ~yt.data_objects.derived_quantities._ParticleSpinParameter
+ ~yt.data_objects.derived_quantities._TotalMass
+ ~yt.data_objects.derived_quantities._TotalQuantity
+ ~yt.data_objects.derived_quantities._WeightedAverageQuantity
+
+.. _callback-api:
+
+Callback List
+=============
+
+
+See also :ref:`callbacks`.
+
+.. autosummary::
+ :toctree: generated/
+
+ ~yt.visualization.plot_modifications.ArrowCallback
+ ~yt.visualization.plot_modifications.ClumpContourCallback
+ ~yt.visualization.plot_modifications.ContourCallback
+ ~yt.visualization.plot_modifications.CoordAxesCallback
+ ~yt.visualization.plot_modifications.CuttingQuiverCallback
+ ~yt.visualization.plot_modifications.GridBoundaryCallback
+ ~yt.visualization.plot_modifications.HopCircleCallback
+ ~yt.visualization.plot_modifications.HopParticleCallback
+ ~yt.visualization.plot_modifications.LabelCallback
+ ~yt.visualization.plot_modifications.LinePlotCallback
+ ~yt.visualization.plot_modifications.MarkerAnnotateCallback
+ ~yt.visualization.plot_modifications.ParticleCallback
+ ~yt.visualization.plot_modifications.PointAnnotateCallback
+ ~yt.visualization.plot_modifications.QuiverCallback
+ ~yt.visualization.plot_modifications.SphereCallback
+ ~yt.visualization.plot_modifications.TextLabelCallback
+ ~yt.visualization.plot_modifications.TitleCallback
+ ~yt.visualization.plot_modifications.UnitBoundaryCallback
+ ~yt.visualization.plot_modifications.VelocityCallback
+ ~yt.visualization.plot_modifications.VobozCircleCallback
+
+Function List
+=============
+
+
+.. autosummary::
+ :toctree: generated/
+
+ ~yt.convenience.load
+ ~yt.funcs.deprecate
+ ~yt.funcs.ensure_list
+ ~yt.funcs.get_pbar
+ ~yt.funcs.humanize_time
+ ~yt.funcs.insert_ipython
+ ~yt.funcs.iterable
+ ~yt.funcs.just_one
+ ~yt.funcs.only_on_root
+ ~yt.funcs.paste_traceback
+ ~yt.funcs.pdb_run
+ ~yt.funcs.print_tb
+ ~yt.funcs.rootonly
+ ~yt.funcs.time_execution
+ ~yt.analysis_modules.level_sets.contour_finder.identify_contours
+ ~yt.utilities.parallel_tools.parallel_analysis_interface.parallel_blocking_call
+ ~yt.utilities.parallel_tools.parallel_analysis_interface.parallel_passthrough
+ ~yt.utilities.parallel_tools.parallel_analysis_interface.parallel_root_only
+ ~yt.utilities.parallel_tools.parallel_analysis_interface.parallel_simple_proxy
+ ~yt.utilities.parallel_tools.parallel_analysis_interface.parallel_splitter
+
+Miscellaneous Types
+===================
+
+
+.. autosummary::
+ :toctree: generated/
+
+ ~yt.config.YTConfigParser
+ ~yt.analysis_modules.hierarchy_subset.hierarchy_subset.ConstructedRootGrid
+ ~yt.analysis_modules.hierarchy_subset.hierarchy_subset.ExtractedHierarchy
+ ~yt.analysis_modules.spectral_integrator.spectral_frequency_integrator.SpectralFrequencyIntegrator
+ ~yt.utilities.parameter_file_storage.ParameterFileStore
+ ~yt.data_objects.data_containers.FakeGridForParticles
+ ~yt.utilities.parallel_tools.parallel_analysis_interface.ObjectIterator
+ ~yt.utilities.parallel_tools.parallel_analysis_interface.ParallelAnalysisInterface
+ ~yt.utilities.parallel_tools.parallel_analysis_interface.ParallelObjectIterator
diff -r 64ad5aeaa3dca9aa0ee05e50661aebbe07d53374 -r 50dee20c36b0ff0080455c4308823af894135f30 source/api/index.rst
--- /dev/null
+++ b/source/api/index.rst
@@ -0,0 +1,7 @@
+API Documentation
+=================
+
+.. toctree::
+ :maxdepth: 2
+
+ api
diff -r 64ad5aeaa3dca9aa0ee05e50661aebbe07d53374 -r 50dee20c36b0ff0080455c4308823af894135f30 source/changelog.rst
--- a/source/changelog.rst
+++ b/source/changelog.rst
@@ -5,9 +5,10 @@
This is a non-comprehensive log of changes to the code.
-Version 2.3
+Version 2.3
-----------
+`(Docs) <http://yt-project.org/docs/2.3>`_
* Multi-level parallelism
* Real, extensive answer tests
* Boolean data regions (see :ref:`boolean_data_objects`)
@@ -30,6 +31,7 @@
Version 2.2
-----------
+`(Docs) <http://yt-project.org/docs/2.2>`_
* Command-line submission to the yt Hub (http://hub.yt-project.org/)
* Initial release of the web-based GUI Reason, designed for efficient remote
usage over SSH tunnels (see :ref:`reason`)
@@ -48,6 +50,7 @@
Version 2.1
-----------
+`(Docs) <http://yt-project.org/docs/2.1>`_
* HEALpix-based volume rendering for 4pi, allsky volume rendering
* libconfig is now included
* SQLite3 and Forthon now included by default in the install script
diff -r 64ad5aeaa3dca9aa0ee05e50661aebbe07d53374 -r 50dee20c36b0ff0080455c4308823af894135f30 source/index.rst
--- a/source/index.rst
+++ b/source/index.rst
@@ -27,27 +27,6 @@
For more information, please visit `our homepage <http://yt-project.org/>`_
and for help, please see :ref:`asking-for-help`.
-.. toctree::
- :maxdepth: 1
- :hidden:
-
- welcome/index
- orientation/index
- help/index
- analyzing/index
- visualizing/index
- interacting/index
- analysis_modules/index
- advanced/index
- getting_involved/index
- cookbook/index
- field_list
- api
- changelog
- configuration
- faq/index
-
-
.. raw:: html
<h2>Getting Started</h2>
@@ -97,8 +76,53 @@
</td></tr>
+ <tr valign="top">
+ <td width="25%">
+ <p>
+ <a href="cookbook/index.html">The Cookbook</a>
+ </p>
+ </td>
+ <td width="75%">
+ <p class="linkdescr">A bunch of illustrated examples of how to do things</p>
+ </td>
+ </tr>
+
+ <tr valign="top">
+ <td width="25%">
+ <p>
+ <a href="faq/index.html">FAQ</a>
+ </p>
+ </td>
+ <td width="75%">
+ <p class="linkdescr">Frequently Asked Questions: answered for you!</p>
+ </td>
+ </tr>
+
</table>
-
+
+ <h2>User Guide</h2>
+
+.. toctree::
+ :maxdepth: 2
+
+ welcome/index
+ orientation/index
+ help/index
+ interacting/index
+ cookbook/index
+ analyzing/index
+ visualizing/index
+ analysis_modules/index
+ advanced/index
+ getting_involved/index
+ configuration
+ field_list
+ api/index
+ faq/index
+ changelog
+
+.. raw:: html
+ :hidden:
<h2>Everyday yt</h2><table class="contentstable" align="center">
@@ -178,17 +202,7 @@
<h2>Reference Materials</h2><table class="contentstable" align="center">
- <tr valign="top">
- <td width="25%">
- <p>
- <a href="cookbook/index.html">The Cookbook</a>
- </p>
- </td>
- <td width="75%">
- <p class="linkdescr">A bunch of illustrated examples of how to do things</p>
- </td>
- </tr>
-
+
<tr valign="top"><td width="25%"><p>
@@ -200,18 +214,7 @@
</td></tr>
- <tr valign="top">
- <td width="25%">
- <p>
- <a href="faq/index.html">FAQ</a>
- </p>
- </td>
- <td width="75%">
- <p class="linkdescr">Frequently Asked Questions: answered for you!</p>
- </td>
- </tr>
-
- <tr valign="top">
+ <tr valign="top"><td width="25%"><p><a href="api.html">Function and Class List</a>
@@ -236,17 +239,6 @@
<tr valign="top"><td width="25%"><p>
- <a href="field_list.html">Field List</a>
- </p>
- </td>
- <td width="75%">
- <p class="linkdescr">All the derived fields yt knows how to generate.</p>
- </td>
- </tr>
-
- <tr valign="top">
- <td width="25%">
- <p><a href="configuration.html">Configuration</a></p></td>
https://bitbucket.org/yt_analysis/yt-doc/changeset/6584111f7558/
changeset: 6584111f7558
user: samskillman
date: 2012-07-12 17:17:37
summary: Moving configuration up.
affected #: 1 file
diff -r 50dee20c36b0ff0080455c4308823af894135f30 -r 6584111f7558c58ff6cc3cb773f332a08eca3904 source/index.rst
--- a/source/index.rst
+++ b/source/index.rst
@@ -109,13 +109,13 @@
orientation/index
help/index
interacting/index
+ configuration
cookbook/index
analyzing/index
visualizing/index
analysis_modules/index
advanced/index
getting_involved/index
- configuration
field_list
api/index
faq/index
Repository URL: https://bitbucket.org/yt_analysis/yt-doc/
--
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