From 95dc1d1396e6cf76c2652f439ad356935ef8a66e Mon Sep 17 00:00:00 2001 From: Antti Soininen <soininen@ill.fr> Date: Fri, 23 Jun 2017 15:25:03 +0200 Subject: [PATCH] Move technique sources from python api docs to Techniques category. Re #19921 --- docs/source/api/python/index.rst | 9 --------- .../{api/python => }/techniques/ISISPowder-GEM-v1.rst | 2 ++ .../{api/python => }/techniques/ISISPowder-Index-v1.rst | 2 ++ .../{api/python => }/techniques/ISISPowder-Pearl-v1.rst | 2 ++ .../python => }/techniques/ISISPowder-Polaris-v1.rst | 2 ++ .../techniques/ISISPowder-SampleDetails-v1.rst | 4 +++- .../{api/python => }/techniques/ISISPowder-Tutorials.rst | 2 ++ docs/source/{api/python => }/techniques/calibration.rst | 2 ++ .../techniques/calibration_implementation.rst | 2 ++ 9 files changed, 17 insertions(+), 10 deletions(-) rename docs/source/{api/python => }/techniques/ISISPowder-GEM-v1.rst (99%) rename docs/source/{api/python => }/techniques/ISISPowder-Index-v1.rst (98%) rename docs/source/{api/python => }/techniques/ISISPowder-Pearl-v1.rst (99%) rename docs/source/{api/python => }/techniques/ISISPowder-Polaris-v1.rst (99%) rename docs/source/{api/python => }/techniques/ISISPowder-SampleDetails-v1.rst (99%) rename docs/source/{api/python => }/techniques/ISISPowder-Tutorials.rst (99%) rename docs/source/{api/python => }/techniques/calibration.rst (93%) rename docs/source/{api/python => }/techniques/calibration_implementation.rst (94%) diff --git a/docs/source/api/python/index.rst b/docs/source/api/python/index.rst index fbd05f9122a..3490c7c58bb 100644 --- a/docs/source/api/python/index.rst +++ b/docs/source/api/python/index.rst @@ -19,15 +19,6 @@ Matplotlib-like plotting interface mantidplot.pyplot <mantidplot/pyplot/index> -Techniques ----------- - -.. toctree:: - :glob: - :maxdepth: 1 - - techniques/* - Reference --------- .. toctree:: diff --git a/docs/source/api/python/techniques/ISISPowder-GEM-v1.rst b/docs/source/techniques/ISISPowder-GEM-v1.rst similarity index 99% rename from docs/source/api/python/techniques/ISISPowder-GEM-v1.rst rename to docs/source/techniques/ISISPowder-GEM-v1.rst index 43429385341..70115d973e9 100644 --- a/docs/source/api/python/techniques/ISISPowder-GEM-v1.rst +++ b/docs/source/techniques/ISISPowder-GEM-v1.rst @@ -697,3 +697,5 @@ On GEM this is set to the following: (510, 19500), # Bank 5 (510, 18000) # Bank 6 ] + +.. categories:: Techniques diff --git a/docs/source/api/python/techniques/ISISPowder-Index-v1.rst b/docs/source/techniques/ISISPowder-Index-v1.rst similarity index 98% rename from docs/source/api/python/techniques/ISISPowder-Index-v1.rst rename to docs/source/techniques/ISISPowder-Index-v1.rst index a59b20d6a17..869858e75c5 100644 --- a/docs/source/api/python/techniques/ISISPowder-Index-v1.rst +++ b/docs/source/techniques/ISISPowder-Index-v1.rst @@ -52,3 +52,5 @@ Instrument Reference - :ref:`isis-powder-diffraction-gem-ref` - :ref:`isis-powder-diffraction-pearl-ref` - :ref:`isis-powder-diffraction-polaris-ref` + +.. categories:: Techniques diff --git a/docs/source/api/python/techniques/ISISPowder-Pearl-v1.rst b/docs/source/techniques/ISISPowder-Pearl-v1.rst similarity index 99% rename from docs/source/api/python/techniques/ISISPowder-Pearl-v1.rst rename to docs/source/techniques/ISISPowder-Pearl-v1.rst index 3964f8a1661..691f4ecdc46 100644 --- a/docs/source/api/python/techniques/ISISPowder-Pearl-v1.rst +++ b/docs/source/techniques/ISISPowder-Pearl-v1.rst @@ -847,3 +847,5 @@ On PEARL this is set to the following: vanadium_tof_cropping: (1400, 19990) # Long mode ON: vanadium_tof_cropping: (20295, 39993) + +.. categories:: Techniques diff --git a/docs/source/api/python/techniques/ISISPowder-Polaris-v1.rst b/docs/source/techniques/ISISPowder-Polaris-v1.rst similarity index 99% rename from docs/source/api/python/techniques/ISISPowder-Polaris-v1.rst rename to docs/source/techniques/ISISPowder-Polaris-v1.rst index 4806fd5a654..176e724f852 100644 --- a/docs/source/api/python/techniques/ISISPowder-Polaris-v1.rst +++ b/docs/source/techniques/ISISPowder-Polaris-v1.rst @@ -689,3 +689,5 @@ On POLARIS this is set to the following: (800, 19995), # Bank 4 (800, 19995), # Bank 5 ] + +.. categories:: Techniques diff --git a/docs/source/api/python/techniques/ISISPowder-SampleDetails-v1.rst b/docs/source/techniques/ISISPowder-SampleDetails-v1.rst similarity index 99% rename from docs/source/api/python/techniques/ISISPowder-SampleDetails-v1.rst rename to docs/source/techniques/ISISPowder-SampleDetails-v1.rst index 3d872cb1104..21b55506307 100644 --- a/docs/source/api/python/techniques/ISISPowder-SampleDetails-v1.rst +++ b/docs/source/techniques/ISISPowder-SampleDetails-v1.rst @@ -225,4 +225,6 @@ advanced properties and chemical properties). .. code-block:: python - sample_obj.reset_sample_material() \ No newline at end of file + sample_obj.reset_sample_material() + +.. categories:: Techniques diff --git a/docs/source/api/python/techniques/ISISPowder-Tutorials.rst b/docs/source/techniques/ISISPowder-Tutorials.rst similarity index 99% rename from docs/source/api/python/techniques/ISISPowder-Tutorials.rst rename to docs/source/techniques/ISISPowder-Tutorials.rst index bad9ae6ebdc..87854e3d4e3 100644 --- a/docs/source/api/python/techniques/ISISPowder-Tutorials.rst +++ b/docs/source/techniques/ISISPowder-Tutorials.rst @@ -896,3 +896,5 @@ If you change a value within the advanced config file you will need to restart Mantid for it to take effect. If you are happy with the new value please ensure you forward it on to the Mantid development team to be distributed in future versions. + +.. categories:: Techniques diff --git a/docs/source/api/python/techniques/calibration.rst b/docs/source/techniques/calibration.rst similarity index 93% rename from docs/source/api/python/techniques/calibration.rst rename to docs/source/techniques/calibration.rst index cb6a803a295..3e387978f1d 100644 --- a/docs/source/api/python/techniques/calibration.rst +++ b/docs/source/techniques/calibration.rst @@ -18,3 +18,5 @@ in: :maxdepth: 1 calibration_implementation + +.. categories:: Techniques diff --git a/docs/source/api/python/techniques/calibration_implementation.rst b/docs/source/techniques/calibration_implementation.rst similarity index 94% rename from docs/source/api/python/techniques/calibration_implementation.rst rename to docs/source/techniques/calibration_implementation.rst index a532201e936..c180d758418 100644 --- a/docs/source/api/python/techniques/calibration_implementation.rst +++ b/docs/source/techniques/calibration_implementation.rst @@ -23,3 +23,5 @@ IdealTube .. autoclass:: ideal_tube.IdealTube :members: + +.. categories:: Techniques -- GitLab