diff --git a/.cirrus.yml b/.cirrus.yml index d4aedd3955..971bd3b81b 100644 --- a/.cirrus.yml +++ b/.cirrus.yml @@ -106,7 +106,7 @@ linux_minimal_task: << : *LINUX_TASK_TEMPLATE tests_script: - echo "[Resources]" > ${SITE_CFG} - - echo "doc_dir = ${CIRRUS_WORKING_DIR}/docs/iris" >> ${SITE_CFG} + - echo "doc_dir = ${CIRRUS_WORKING_DIR}/docs" >> ${SITE_CFG} - nox --session tests @@ -136,7 +136,7 @@ linux_task: tests_script: - echo "[Resources]" > ${SITE_CFG} - echo "test_data_dir = ${IRIS_TEST_DATA_DIR}/test_data" >> ${SITE_CFG} - - echo "doc_dir = ${CIRRUS_WORKING_DIR}/docs/iris" >> ${SITE_CFG} + - echo "doc_dir = ${CIRRUS_WORKING_DIR}/docs" >> ${SITE_CFG} - nox --session tests @@ -166,7 +166,7 @@ gallery_task: tests_script: - echo "[Resources]" > ${SITE_CFG} - echo "test_data_dir = ${IRIS_TEST_DATA_DIR}/test_data" >> ${SITE_CFG} - - echo "doc_dir = ${CIRRUS_WORKING_DIR}/docs/iris" >> ${SITE_CFG} + - echo "doc_dir = ${CIRRUS_WORKING_DIR}/docs" >> ${SITE_CFG} - nox --session gallery @@ -197,7 +197,7 @@ doctest_task: tests_script: - echo "[Resources]" > ${SITE_CFG} - echo "test_data_dir = ${IRIS_TEST_DATA_DIR}/test_data" >> ${SITE_CFG} - - echo "doc_dir = ${CIRRUS_WORKING_DIR}/docs/iris" >> ${SITE_CFG} + - echo "doc_dir = ${CIRRUS_WORKING_DIR}/docs" >> ${SITE_CFG} - mkdir -p ${MPL_RC_DIR} - echo "backend : agg" > ${MPL_RC_FILE} - echo "image.cmap : viridis" >> ${MPL_RC_FILE} diff --git a/.flake8 b/.flake8 index e313fc2ac5..807e8c0de1 100644 --- a/.flake8 +++ b/.flake8 @@ -30,7 +30,7 @@ exclude = .eggs, build, compiled_krb, - docs/iris/src/sphinxext/*, + docs/src/sphinxext/*, tools/*, # # ignore auto-generated files diff --git a/.gitignore b/.gitignore index 618913e7ec..4a589524d2 100644 --- a/.gitignore +++ b/.gitignore @@ -56,11 +56,11 @@ lib/iris/tests/results/imagerepo.lock *.cover # Auto generated documentation files -docs/iris/src/_build/* -docs/iris/src/generated +docs/src/_build/* +docs/src/generated # Example test results -docs/iris/iris_image_test_output/ +docs/iris_image_test_output/ # Created by editiors *~ diff --git a/.readthedocs.yml b/.readthedocs.yml index bfc8cfa72b..b54b0f065b 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -7,7 +7,7 @@ conda: environment: requirements/ci/readthedocs.yml sphinx: - configuration: docs/iris/src/conf.py + configuration: docs/src/conf.py fail_on_warning: false python: diff --git a/CHANGES b/CHANGES index 2364de84a4..cdb2b64f84 100644 --- a/CHANGES +++ b/CHANGES @@ -1,5 +1,5 @@ This file is no longer updated and is provided for historical purposes only. -Please see docs/iris/src/whatsnew/ for a changelog. +Please see docs/src/whatsnew/ for a changelog. Release 1.4 (14 June 2013) diff --git a/MANIFEST.in b/MANIFEST.in index 6f6ec445a2..99b801e827 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -11,7 +11,7 @@ include requirements/*.txt # File required to build docs recursive-include docs Makefile *.js *.png *.py *.rst -prune docs/iris/build +prune docs/build # Files required to build std_names module include tools/generate_std_names.py diff --git a/README.md b/README.md index 6339491955..0ceac7e089 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

- Iris
+ Iris

diff --git a/docs/iris/Makefile b/docs/Makefile similarity index 100% rename from docs/iris/Makefile rename to docs/Makefile diff --git a/docs/iris/gallery_code/README.rst b/docs/gallery_code/README.rst similarity index 100% rename from docs/iris/gallery_code/README.rst rename to docs/gallery_code/README.rst diff --git a/docs/iris/gallery_code/general/README.rst b/docs/gallery_code/general/README.rst similarity index 100% rename from docs/iris/gallery_code/general/README.rst rename to docs/gallery_code/general/README.rst diff --git a/docs/iris/gallery_code/general/plot_SOI_filtering.py b/docs/gallery_code/general/plot_SOI_filtering.py similarity index 100% rename from docs/iris/gallery_code/general/plot_SOI_filtering.py rename to docs/gallery_code/general/plot_SOI_filtering.py diff --git a/docs/iris/gallery_code/general/plot_anomaly_log_colouring.py b/docs/gallery_code/general/plot_anomaly_log_colouring.py similarity index 100% rename from docs/iris/gallery_code/general/plot_anomaly_log_colouring.py rename to docs/gallery_code/general/plot_anomaly_log_colouring.py diff --git a/docs/iris/gallery_code/general/plot_coriolis.py b/docs/gallery_code/general/plot_coriolis.py similarity index 100% rename from docs/iris/gallery_code/general/plot_coriolis.py rename to docs/gallery_code/general/plot_coriolis.py diff --git a/docs/iris/gallery_code/general/plot_cross_section.py b/docs/gallery_code/general/plot_cross_section.py similarity index 100% rename from docs/iris/gallery_code/general/plot_cross_section.py rename to docs/gallery_code/general/plot_cross_section.py diff --git a/docs/iris/gallery_code/general/plot_custom_aggregation.py b/docs/gallery_code/general/plot_custom_aggregation.py similarity index 100% rename from docs/iris/gallery_code/general/plot_custom_aggregation.py rename to docs/gallery_code/general/plot_custom_aggregation.py diff --git a/docs/iris/gallery_code/general/plot_custom_file_loading.py b/docs/gallery_code/general/plot_custom_file_loading.py similarity index 100% rename from docs/iris/gallery_code/general/plot_custom_file_loading.py rename to docs/gallery_code/general/plot_custom_file_loading.py diff --git a/docs/iris/gallery_code/general/plot_global_map.py b/docs/gallery_code/general/plot_global_map.py similarity index 100% rename from docs/iris/gallery_code/general/plot_global_map.py rename to docs/gallery_code/general/plot_global_map.py diff --git a/docs/iris/gallery_code/general/plot_inset.py b/docs/gallery_code/general/plot_inset.py similarity index 100% rename from docs/iris/gallery_code/general/plot_inset.py rename to docs/gallery_code/general/plot_inset.py diff --git a/docs/iris/gallery_code/general/plot_lineplot_with_legend.py b/docs/gallery_code/general/plot_lineplot_with_legend.py similarity index 100% rename from docs/iris/gallery_code/general/plot_lineplot_with_legend.py rename to docs/gallery_code/general/plot_lineplot_with_legend.py diff --git a/docs/iris/gallery_code/general/plot_polar_stereo.py b/docs/gallery_code/general/plot_polar_stereo.py similarity index 100% rename from docs/iris/gallery_code/general/plot_polar_stereo.py rename to docs/gallery_code/general/plot_polar_stereo.py diff --git a/docs/iris/gallery_code/general/plot_polynomial_fit.py b/docs/gallery_code/general/plot_polynomial_fit.py similarity index 100% rename from docs/iris/gallery_code/general/plot_polynomial_fit.py rename to docs/gallery_code/general/plot_polynomial_fit.py diff --git a/docs/iris/gallery_code/general/plot_projections_and_annotations.py b/docs/gallery_code/general/plot_projections_and_annotations.py similarity index 100% rename from docs/iris/gallery_code/general/plot_projections_and_annotations.py rename to docs/gallery_code/general/plot_projections_and_annotations.py diff --git a/docs/iris/gallery_code/general/plot_rotated_pole_mapping.py b/docs/gallery_code/general/plot_rotated_pole_mapping.py similarity index 100% rename from docs/iris/gallery_code/general/plot_rotated_pole_mapping.py rename to docs/gallery_code/general/plot_rotated_pole_mapping.py diff --git a/docs/iris/gallery_code/meteorology/README.rst b/docs/gallery_code/meteorology/README.rst similarity index 100% rename from docs/iris/gallery_code/meteorology/README.rst rename to docs/gallery_code/meteorology/README.rst diff --git a/docs/iris/gallery_code/meteorology/plot_COP_1d.py b/docs/gallery_code/meteorology/plot_COP_1d.py similarity index 100% rename from docs/iris/gallery_code/meteorology/plot_COP_1d.py rename to docs/gallery_code/meteorology/plot_COP_1d.py diff --git a/docs/iris/gallery_code/meteorology/plot_COP_maps.py b/docs/gallery_code/meteorology/plot_COP_maps.py similarity index 100% rename from docs/iris/gallery_code/meteorology/plot_COP_maps.py rename to docs/gallery_code/meteorology/plot_COP_maps.py diff --git a/docs/iris/gallery_code/meteorology/plot_TEC.py b/docs/gallery_code/meteorology/plot_TEC.py similarity index 100% rename from docs/iris/gallery_code/meteorology/plot_TEC.py rename to docs/gallery_code/meteorology/plot_TEC.py diff --git a/docs/iris/gallery_code/meteorology/plot_deriving_phenomena.py b/docs/gallery_code/meteorology/plot_deriving_phenomena.py similarity index 100% rename from docs/iris/gallery_code/meteorology/plot_deriving_phenomena.py rename to docs/gallery_code/meteorology/plot_deriving_phenomena.py diff --git a/docs/iris/gallery_code/meteorology/plot_hovmoller.py b/docs/gallery_code/meteorology/plot_hovmoller.py similarity index 100% rename from docs/iris/gallery_code/meteorology/plot_hovmoller.py rename to docs/gallery_code/meteorology/plot_hovmoller.py diff --git a/docs/iris/gallery_code/meteorology/plot_lagged_ensemble.py b/docs/gallery_code/meteorology/plot_lagged_ensemble.py similarity index 100% rename from docs/iris/gallery_code/meteorology/plot_lagged_ensemble.py rename to docs/gallery_code/meteorology/plot_lagged_ensemble.py diff --git a/docs/iris/gallery_code/meteorology/plot_wind_speed.py b/docs/gallery_code/meteorology/plot_wind_speed.py similarity index 100% rename from docs/iris/gallery_code/meteorology/plot_wind_speed.py rename to docs/gallery_code/meteorology/plot_wind_speed.py diff --git a/docs/iris/gallery_code/oceanography/README.rst b/docs/gallery_code/oceanography/README.rst similarity index 100% rename from docs/iris/gallery_code/oceanography/README.rst rename to docs/gallery_code/oceanography/README.rst diff --git a/docs/iris/gallery_code/oceanography/plot_atlantic_profiles.py b/docs/gallery_code/oceanography/plot_atlantic_profiles.py similarity index 100% rename from docs/iris/gallery_code/oceanography/plot_atlantic_profiles.py rename to docs/gallery_code/oceanography/plot_atlantic_profiles.py diff --git a/docs/iris/gallery_code/oceanography/plot_load_nemo.py b/docs/gallery_code/oceanography/plot_load_nemo.py similarity index 100% rename from docs/iris/gallery_code/oceanography/plot_load_nemo.py rename to docs/gallery_code/oceanography/plot_load_nemo.py diff --git a/docs/iris/gallery_code/oceanography/plot_orca_projection.py b/docs/gallery_code/oceanography/plot_orca_projection.py similarity index 100% rename from docs/iris/gallery_code/oceanography/plot_orca_projection.py rename to docs/gallery_code/oceanography/plot_orca_projection.py diff --git a/docs/iris/gallery_tests/__init__.py b/docs/gallery_tests/__init__.py similarity index 100% rename from docs/iris/gallery_tests/__init__.py rename to docs/gallery_tests/__init__.py diff --git a/docs/iris/gallery_tests/gallerytest_util.py b/docs/gallery_tests/gallerytest_util.py similarity index 100% rename from docs/iris/gallery_tests/gallerytest_util.py rename to docs/gallery_tests/gallerytest_util.py diff --git a/docs/iris/gallery_tests/test_plot_COP_1d.py b/docs/gallery_tests/test_plot_COP_1d.py similarity index 100% rename from docs/iris/gallery_tests/test_plot_COP_1d.py rename to docs/gallery_tests/test_plot_COP_1d.py diff --git a/docs/iris/gallery_tests/test_plot_COP_maps.py b/docs/gallery_tests/test_plot_COP_maps.py similarity index 100% rename from docs/iris/gallery_tests/test_plot_COP_maps.py rename to docs/gallery_tests/test_plot_COP_maps.py diff --git a/docs/iris/gallery_tests/test_plot_SOI_filtering.py b/docs/gallery_tests/test_plot_SOI_filtering.py similarity index 100% rename from docs/iris/gallery_tests/test_plot_SOI_filtering.py rename to docs/gallery_tests/test_plot_SOI_filtering.py diff --git a/docs/iris/gallery_tests/test_plot_TEC.py b/docs/gallery_tests/test_plot_TEC.py similarity index 100% rename from docs/iris/gallery_tests/test_plot_TEC.py rename to docs/gallery_tests/test_plot_TEC.py diff --git a/docs/iris/gallery_tests/test_plot_anomaly_log_colouring.py b/docs/gallery_tests/test_plot_anomaly_log_colouring.py similarity index 100% rename from docs/iris/gallery_tests/test_plot_anomaly_log_colouring.py rename to docs/gallery_tests/test_plot_anomaly_log_colouring.py diff --git a/docs/iris/gallery_tests/test_plot_atlantic_profiles.py b/docs/gallery_tests/test_plot_atlantic_profiles.py similarity index 100% rename from docs/iris/gallery_tests/test_plot_atlantic_profiles.py rename to docs/gallery_tests/test_plot_atlantic_profiles.py diff --git a/docs/iris/gallery_tests/test_plot_coriolis.py b/docs/gallery_tests/test_plot_coriolis.py similarity index 100% rename from docs/iris/gallery_tests/test_plot_coriolis.py rename to docs/gallery_tests/test_plot_coriolis.py diff --git a/docs/iris/gallery_tests/test_plot_cross_section.py b/docs/gallery_tests/test_plot_cross_section.py similarity index 100% rename from docs/iris/gallery_tests/test_plot_cross_section.py rename to docs/gallery_tests/test_plot_cross_section.py diff --git a/docs/iris/gallery_tests/test_plot_custom_aggregation.py b/docs/gallery_tests/test_plot_custom_aggregation.py similarity index 100% rename from docs/iris/gallery_tests/test_plot_custom_aggregation.py rename to docs/gallery_tests/test_plot_custom_aggregation.py diff --git a/docs/iris/gallery_tests/test_plot_custom_file_loading.py b/docs/gallery_tests/test_plot_custom_file_loading.py similarity index 100% rename from docs/iris/gallery_tests/test_plot_custom_file_loading.py rename to docs/gallery_tests/test_plot_custom_file_loading.py diff --git a/docs/iris/gallery_tests/test_plot_deriving_phenomena.py b/docs/gallery_tests/test_plot_deriving_phenomena.py similarity index 100% rename from docs/iris/gallery_tests/test_plot_deriving_phenomena.py rename to docs/gallery_tests/test_plot_deriving_phenomena.py diff --git a/docs/iris/gallery_tests/test_plot_global_map.py b/docs/gallery_tests/test_plot_global_map.py similarity index 100% rename from docs/iris/gallery_tests/test_plot_global_map.py rename to docs/gallery_tests/test_plot_global_map.py diff --git a/docs/iris/gallery_tests/test_plot_hovmoller.py b/docs/gallery_tests/test_plot_hovmoller.py similarity index 100% rename from docs/iris/gallery_tests/test_plot_hovmoller.py rename to docs/gallery_tests/test_plot_hovmoller.py diff --git a/docs/iris/gallery_tests/test_plot_inset.py b/docs/gallery_tests/test_plot_inset.py similarity index 100% rename from docs/iris/gallery_tests/test_plot_inset.py rename to docs/gallery_tests/test_plot_inset.py diff --git a/docs/iris/gallery_tests/test_plot_lagged_ensemble.py b/docs/gallery_tests/test_plot_lagged_ensemble.py similarity index 100% rename from docs/iris/gallery_tests/test_plot_lagged_ensemble.py rename to docs/gallery_tests/test_plot_lagged_ensemble.py diff --git a/docs/iris/gallery_tests/test_plot_lineplot_with_legend.py b/docs/gallery_tests/test_plot_lineplot_with_legend.py similarity index 100% rename from docs/iris/gallery_tests/test_plot_lineplot_with_legend.py rename to docs/gallery_tests/test_plot_lineplot_with_legend.py diff --git a/docs/iris/gallery_tests/test_plot_load_nemo.py b/docs/gallery_tests/test_plot_load_nemo.py similarity index 100% rename from docs/iris/gallery_tests/test_plot_load_nemo.py rename to docs/gallery_tests/test_plot_load_nemo.py diff --git a/docs/iris/gallery_tests/test_plot_orca_projection.py b/docs/gallery_tests/test_plot_orca_projection.py similarity index 100% rename from docs/iris/gallery_tests/test_plot_orca_projection.py rename to docs/gallery_tests/test_plot_orca_projection.py diff --git a/docs/iris/gallery_tests/test_plot_polar_stereo.py b/docs/gallery_tests/test_plot_polar_stereo.py similarity index 100% rename from docs/iris/gallery_tests/test_plot_polar_stereo.py rename to docs/gallery_tests/test_plot_polar_stereo.py diff --git a/docs/iris/gallery_tests/test_plot_polynomial_fit.py b/docs/gallery_tests/test_plot_polynomial_fit.py similarity index 100% rename from docs/iris/gallery_tests/test_plot_polynomial_fit.py rename to docs/gallery_tests/test_plot_polynomial_fit.py diff --git a/docs/iris/gallery_tests/test_plot_projections_and_annotations.py b/docs/gallery_tests/test_plot_projections_and_annotations.py similarity index 100% rename from docs/iris/gallery_tests/test_plot_projections_and_annotations.py rename to docs/gallery_tests/test_plot_projections_and_annotations.py diff --git a/docs/iris/gallery_tests/test_plot_rotated_pole_mapping.py b/docs/gallery_tests/test_plot_rotated_pole_mapping.py similarity index 100% rename from docs/iris/gallery_tests/test_plot_rotated_pole_mapping.py rename to docs/gallery_tests/test_plot_rotated_pole_mapping.py diff --git a/docs/iris/gallery_tests/test_plot_wind_speed.py b/docs/gallery_tests/test_plot_wind_speed.py similarity index 100% rename from docs/iris/gallery_tests/test_plot_wind_speed.py rename to docs/gallery_tests/test_plot_wind_speed.py diff --git a/docs/iris/src/IEP/IEP001.adoc b/docs/src/IEP/IEP001.adoc similarity index 100% rename from docs/iris/src/IEP/IEP001.adoc rename to docs/src/IEP/IEP001.adoc diff --git a/docs/iris/src/Makefile b/docs/src/Makefile similarity index 100% rename from docs/iris/src/Makefile rename to docs/src/Makefile diff --git a/docs/iris/src/_static/Iris7_1_trim_100.png b/docs/src/_static/Iris7_1_trim_100.png similarity index 100% rename from docs/iris/src/_static/Iris7_1_trim_100.png rename to docs/src/_static/Iris7_1_trim_100.png diff --git a/docs/iris/src/_static/Iris7_1_trim_full.png b/docs/src/_static/Iris7_1_trim_full.png similarity index 100% rename from docs/iris/src/_static/Iris7_1_trim_full.png rename to docs/src/_static/Iris7_1_trim_full.png diff --git a/docs/iris/src/_static/favicon.ico b/docs/src/_static/favicon.ico similarity index 100% rename from docs/iris/src/_static/favicon.ico rename to docs/src/_static/favicon.ico diff --git a/docs/iris/src/_static/iris-logo-title.png b/docs/src/_static/iris-logo-title.png similarity index 100% rename from docs/iris/src/_static/iris-logo-title.png rename to docs/src/_static/iris-logo-title.png diff --git a/docs/iris/src/_static/iris-logo-title.svg b/docs/src/_static/iris-logo-title.svg similarity index 100% rename from docs/iris/src/_static/iris-logo-title.svg rename to docs/src/_static/iris-logo-title.svg diff --git a/docs/iris/src/_static/theme_override.css b/docs/src/_static/theme_override.css similarity index 100% rename from docs/iris/src/_static/theme_override.css rename to docs/src/_static/theme_override.css diff --git a/docs/iris/src/_templates/layout.html b/docs/src/_templates/layout.html similarity index 100% rename from docs/iris/src/_templates/layout.html rename to docs/src/_templates/layout.html diff --git a/docs/iris/src/common_links.inc b/docs/src/common_links.inc similarity index 100% rename from docs/iris/src/common_links.inc rename to docs/src/common_links.inc diff --git a/docs/iris/src/conf.py b/docs/src/conf.py similarity index 100% rename from docs/iris/src/conf.py rename to docs/src/conf.py diff --git a/docs/iris/src/copyright.rst b/docs/src/copyright.rst similarity index 100% rename from docs/iris/src/copyright.rst rename to docs/src/copyright.rst diff --git a/docs/iris/src/developers_guide/ci_checks.png b/docs/src/developers_guide/ci_checks.png similarity index 100% rename from docs/iris/src/developers_guide/ci_checks.png rename to docs/src/developers_guide/ci_checks.png diff --git a/docs/iris/src/developers_guide/contributing_changes.rst b/docs/src/developers_guide/contributing_changes.rst similarity index 100% rename from docs/iris/src/developers_guide/contributing_changes.rst rename to docs/src/developers_guide/contributing_changes.rst diff --git a/docs/iris/src/developers_guide/contributing_ci_tests.rst b/docs/src/developers_guide/contributing_ci_tests.rst similarity index 100% rename from docs/iris/src/developers_guide/contributing_ci_tests.rst rename to docs/src/developers_guide/contributing_ci_tests.rst diff --git a/docs/iris/src/developers_guide/contributing_code_formatting.rst b/docs/src/developers_guide/contributing_code_formatting.rst similarity index 100% rename from docs/iris/src/developers_guide/contributing_code_formatting.rst rename to docs/src/developers_guide/contributing_code_formatting.rst diff --git a/docs/iris/src/developers_guide/contributing_codebase_index.rst b/docs/src/developers_guide/contributing_codebase_index.rst similarity index 100% rename from docs/iris/src/developers_guide/contributing_codebase_index.rst rename to docs/src/developers_guide/contributing_codebase_index.rst diff --git a/docs/iris/src/developers_guide/contributing_deprecations.rst b/docs/src/developers_guide/contributing_deprecations.rst similarity index 100% rename from docs/iris/src/developers_guide/contributing_deprecations.rst rename to docs/src/developers_guide/contributing_deprecations.rst diff --git a/docs/iris/src/developers_guide/contributing_documentation.rst b/docs/src/developers_guide/contributing_documentation.rst similarity index 89% rename from docs/iris/src/developers_guide/contributing_documentation.rst rename to docs/src/developers_guide/contributing_documentation.rst index 56d2257a55..75e9dfe29c 100644 --- a/docs/iris/src/developers_guide/contributing_documentation.rst +++ b/docs/src/developers_guide/contributing_documentation.rst @@ -24,7 +24,7 @@ The documentation uses specific packages that need to be present. Please see Building ~~~~~~~~ -The build can be run from the documentation directory ``iris/docs/iris/src``. +The build can be run from the documentation directory ``docs/src``. The build output for the html is found in the ``_build/html`` sub directory. When updating the documentation ensure the html build has *no errors* or @@ -58,8 +58,8 @@ Testing ~~~~~~~ There are a ways to test various aspects of the documentation. The -``make`` commands shown below can be run in the ``iris/docs/iris`` or -``iris/docs/iris/src`` directory. +``make`` commands shown below can be run in the ``docs`` or +``docs/src`` directory. Each :ref:`contributing.documentation.gallery` entry has a corresponding test. To run the tests:: @@ -107,7 +107,7 @@ or ignore the url. ``.readthedocs.yml``. -.. _conf.py: https://github.com/SciTools/iris/blob/master/docs/iris/src/conf.py +.. _conf.py: https://github.com/SciTools/iris/blob/master/docs/src/conf.py .. _contributing.documentation.api: @@ -117,14 +117,14 @@ Generating API Documentation In order to auto generate the API documentation based upon the docstrings a custom set of python scripts are used, these are located in the directory -``iris/docs/iris/src/sphinxext``. Once the ``make html`` command has been run, +``docs/src/sphinxext``. Once the ``make html`` command has been run, the output of these scripts can be found in -``iris/docs/iris/src/generated/api``. +``docs/src/generated/api``. If there is a particularly troublesome module that breaks the ``make html`` you can exclude the module from the API documentation. Add the entry to the ``exclude_modules`` tuple list in the -``iris/docs/iris/src/sphinxext/generate_package_rst.py`` file. +``docs/src/sphinxext/generate_package_rst.py`` file. .. _contributing.documentation.gallery: @@ -137,12 +137,12 @@ The Iris :ref:`sphx_glr_generated_gallery` uses a sphinx extension named that auto generates reStructuredText (rst) files based upon a gallery source directory that abides directory and filename convention. -The code for the gallery entries are in ``iris/docs/iris/gallery_code``. +The code for the gallery entries are in ``docs/gallery_code``. Each sub directory in this directory is a sub section of the gallery. The respective ``README.rst`` in each folder is included in the gallery output. For each gallery entry there must be a corresponding test script located in -``iris/docs/iris/gallery_tests``. +``docs/gallery_tests``. To add an entry to the gallery simple place your python code into the appropriate sub directory and name it with a prefix of ``plot_``. If your @@ -150,7 +150,7 @@ gallery entry does not fit into any existing sub directories then create a new directory and place it in there. The reStructuredText (rst) output of the gallery is located in -``iris/docs/iris/src/generated/gallery``. +``docs/src/generated/gallery``. For more information on the directory structure and options please see the `sphinx-gallery getting started diff --git a/docs/iris/src/developers_guide/contributing_getting_involved.rst b/docs/src/developers_guide/contributing_getting_involved.rst similarity index 100% rename from docs/iris/src/developers_guide/contributing_getting_involved.rst rename to docs/src/developers_guide/contributing_getting_involved.rst diff --git a/docs/iris/src/developers_guide/contributing_graphics_tests.rst b/docs/src/developers_guide/contributing_graphics_tests.rst similarity index 99% rename from docs/iris/src/developers_guide/contributing_graphics_tests.rst rename to docs/src/developers_guide/contributing_graphics_tests.rst index 8d8189c69b..81ec9c0344 100644 --- a/docs/iris/src/developers_guide/contributing_graphics_tests.rst +++ b/docs/src/developers_guide/contributing_graphics_tests.rst @@ -15,7 +15,7 @@ At present graphical tests are used in the following areas of Iris: * Module ``iris.tests.test_plot`` * Module ``iris.tests.test_quickplot`` * :ref:`sphx_glr_generated_gallery` plots contained in - ``docs/iris/gallery_tests``. + ``docs/gallery_tests``. Challenges diff --git a/docs/iris/src/developers_guide/contributing_pull_request_checklist.rst b/docs/src/developers_guide/contributing_pull_request_checklist.rst similarity index 100% rename from docs/iris/src/developers_guide/contributing_pull_request_checklist.rst rename to docs/src/developers_guide/contributing_pull_request_checklist.rst diff --git a/docs/iris/src/developers_guide/contributing_running_tests.rst b/docs/src/developers_guide/contributing_running_tests.rst similarity index 100% rename from docs/iris/src/developers_guide/contributing_running_tests.rst rename to docs/src/developers_guide/contributing_running_tests.rst diff --git a/docs/iris/src/developers_guide/contributing_testing.rst b/docs/src/developers_guide/contributing_testing.rst similarity index 100% rename from docs/iris/src/developers_guide/contributing_testing.rst rename to docs/src/developers_guide/contributing_testing.rst diff --git a/docs/iris/src/developers_guide/contributing_testing_index.rst b/docs/src/developers_guide/contributing_testing_index.rst similarity index 100% rename from docs/iris/src/developers_guide/contributing_testing_index.rst rename to docs/src/developers_guide/contributing_testing_index.rst diff --git a/docs/iris/src/developers_guide/documenting/__init__.py b/docs/src/developers_guide/documenting/__init__.py similarity index 100% rename from docs/iris/src/developers_guide/documenting/__init__.py rename to docs/src/developers_guide/documenting/__init__.py diff --git a/docs/iris/src/developers_guide/documenting/docstrings.rst b/docs/src/developers_guide/documenting/docstrings.rst similarity index 100% rename from docs/iris/src/developers_guide/documenting/docstrings.rst rename to docs/src/developers_guide/documenting/docstrings.rst diff --git a/docs/iris/src/developers_guide/documenting/docstrings_attribute.py b/docs/src/developers_guide/documenting/docstrings_attribute.py similarity index 100% rename from docs/iris/src/developers_guide/documenting/docstrings_attribute.py rename to docs/src/developers_guide/documenting/docstrings_attribute.py diff --git a/docs/iris/src/developers_guide/documenting/docstrings_sample_routine.py b/docs/src/developers_guide/documenting/docstrings_sample_routine.py similarity index 100% rename from docs/iris/src/developers_guide/documenting/docstrings_sample_routine.py rename to docs/src/developers_guide/documenting/docstrings_sample_routine.py diff --git a/docs/iris/src/developers_guide/documenting/rest_guide.rst b/docs/src/developers_guide/documenting/rest_guide.rst similarity index 100% rename from docs/iris/src/developers_guide/documenting/rest_guide.rst rename to docs/src/developers_guide/documenting/rest_guide.rst diff --git a/docs/iris/src/developers_guide/documenting/whats_new_contributions.rst b/docs/src/developers_guide/documenting/whats_new_contributions.rst similarity index 98% rename from docs/iris/src/developers_guide/documenting/whats_new_contributions.rst rename to docs/src/developers_guide/documenting/whats_new_contributions.rst index 4bd9021333..ebb553024b 100644 --- a/docs/iris/src/developers_guide/documenting/whats_new_contributions.rst +++ b/docs/src/developers_guide/documenting/whats_new_contributions.rst @@ -11,7 +11,7 @@ The contribution should be included as part of the Iris Pull Request that introduces the change. The ``latest.rst`` and the past release notes are kept in -``docs/iris/src/whatsnew/``. If you are writing the first contribution after +``docs/src/whatsnew/``. If you are writing the first contribution after an Iris release: **create the new** ``latest.rst`` by copying the content from ``latest.rst.template`` in the same directory. diff --git a/docs/iris/src/developers_guide/gitwash/LICENSE b/docs/src/developers_guide/gitwash/LICENSE similarity index 100% rename from docs/iris/src/developers_guide/gitwash/LICENSE rename to docs/src/developers_guide/gitwash/LICENSE diff --git a/docs/iris/src/developers_guide/gitwash/branch_dropdown.png b/docs/src/developers_guide/gitwash/branch_dropdown.png similarity index 100% rename from docs/iris/src/developers_guide/gitwash/branch_dropdown.png rename to docs/src/developers_guide/gitwash/branch_dropdown.png diff --git a/docs/iris/src/developers_guide/gitwash/configure_git.rst b/docs/src/developers_guide/gitwash/configure_git.rst similarity index 100% rename from docs/iris/src/developers_guide/gitwash/configure_git.rst rename to docs/src/developers_guide/gitwash/configure_git.rst diff --git a/docs/iris/src/developers_guide/gitwash/development_workflow.rst b/docs/src/developers_guide/gitwash/development_workflow.rst similarity index 100% rename from docs/iris/src/developers_guide/gitwash/development_workflow.rst rename to docs/src/developers_guide/gitwash/development_workflow.rst diff --git a/docs/iris/src/developers_guide/gitwash/forking.rst b/docs/src/developers_guide/gitwash/forking.rst similarity index 100% rename from docs/iris/src/developers_guide/gitwash/forking.rst rename to docs/src/developers_guide/gitwash/forking.rst diff --git a/docs/iris/src/developers_guide/gitwash/forking_button.png b/docs/src/developers_guide/gitwash/forking_button.png similarity index 100% rename from docs/iris/src/developers_guide/gitwash/forking_button.png rename to docs/src/developers_guide/gitwash/forking_button.png diff --git a/docs/iris/src/developers_guide/gitwash/git_intro.rst b/docs/src/developers_guide/gitwash/git_intro.rst similarity index 100% rename from docs/iris/src/developers_guide/gitwash/git_intro.rst rename to docs/src/developers_guide/gitwash/git_intro.rst diff --git a/docs/iris/src/developers_guide/gitwash/git_links.inc b/docs/src/developers_guide/gitwash/git_links.inc similarity index 100% rename from docs/iris/src/developers_guide/gitwash/git_links.inc rename to docs/src/developers_guide/gitwash/git_links.inc diff --git a/docs/iris/src/developers_guide/gitwash/index.rst b/docs/src/developers_guide/gitwash/index.rst similarity index 100% rename from docs/iris/src/developers_guide/gitwash/index.rst rename to docs/src/developers_guide/gitwash/index.rst diff --git a/docs/iris/src/developers_guide/gitwash/links.inc b/docs/src/developers_guide/gitwash/links.inc similarity index 100% rename from docs/iris/src/developers_guide/gitwash/links.inc rename to docs/src/developers_guide/gitwash/links.inc diff --git a/docs/iris/src/developers_guide/gitwash/pull_button.png b/docs/src/developers_guide/gitwash/pull_button.png similarity index 100% rename from docs/iris/src/developers_guide/gitwash/pull_button.png rename to docs/src/developers_guide/gitwash/pull_button.png diff --git a/docs/iris/src/developers_guide/gitwash/set_up_fork.rst b/docs/src/developers_guide/gitwash/set_up_fork.rst similarity index 100% rename from docs/iris/src/developers_guide/gitwash/set_up_fork.rst rename to docs/src/developers_guide/gitwash/set_up_fork.rst diff --git a/docs/iris/src/developers_guide/release.rst b/docs/src/developers_guide/release.rst similarity index 94% rename from docs/iris/src/developers_guide/release.rst rename to docs/src/developers_guide/release.rst index 6ac3af5c75..dd3f96b43d 100644 --- a/docs/iris/src/developers_guide/release.rst +++ b/docs/src/developers_guide/release.rst @@ -131,9 +131,9 @@ Release Steps release as it should already exist #. Update the what's new for the release: - * Copy ``docs/iris/src/whatsnew/latest.rst`` to a file named + * Copy ``docs/src/whatsnew/latest.rst`` to a file named ``v1.9.rst`` - * Delete the ``docs/iris/src/whatsnew/latest.rst`` file so it will not + * Delete the ``docs/src/whatsnew/latest.rst`` file so it will not cause an issue in the build * In ``v1.9.rst`` update the page title (first line of the file) to show the date and version in the format of ``v1.9 (DD MMM YYYY)``. For @@ -144,7 +144,7 @@ Release Steps * Add ``v1.9.rst`` to git and commit all changes, including removal of ``latest.rst`` -#. Update the what's new index ``docs/iris/src/whatsnew/index.rst`` +#. Update the what's new index ``docs/src/whatsnew/index.rst`` * Temporarily remove reference to ``latest.rst`` * Add a reference to ``v1.9.rst`` to the top of the list @@ -164,12 +164,12 @@ Post Release Steps available in the pop out menu in the bottom left corner include the new release version. If it is not present you will need to configure the versions available in the **admin** dashboard in Read The Docs -#. Copy ``docs/iris/src/whatsnew/latest.rst.template`` to - ``docs/iris/src/whatsnew/latest.rst``. This will reset +#. Copy ``docs/src/whatsnew/latest.rst.template`` to + ``docs/src/whatsnew/latest.rst``. This will reset the file with the ``unreleased`` heading and placeholders for the what's new headings #. Add back in the reference to ``latest.rst`` to the what's new index - ``docs/iris/src/whatsnew/index.rst`` + ``docs/src/whatsnew/index.rst`` #. Update ``Iris.__init__.py`` version string to show as ``1.10.dev0`` #. Merge back to master diff --git a/docs/iris/src/further_topics/index.rst b/docs/src/further_topics/index.rst similarity index 100% rename from docs/iris/src/further_topics/index.rst rename to docs/src/further_topics/index.rst diff --git a/docs/iris/src/further_topics/lenient_maths.rst b/docs/src/further_topics/lenient_maths.rst similarity index 100% rename from docs/iris/src/further_topics/lenient_maths.rst rename to docs/src/further_topics/lenient_maths.rst diff --git a/docs/iris/src/further_topics/lenient_metadata.rst b/docs/src/further_topics/lenient_metadata.rst similarity index 100% rename from docs/iris/src/further_topics/lenient_metadata.rst rename to docs/src/further_topics/lenient_metadata.rst diff --git a/docs/iris/src/further_topics/metadata.rst b/docs/src/further_topics/metadata.rst similarity index 100% rename from docs/iris/src/further_topics/metadata.rst rename to docs/src/further_topics/metadata.rst diff --git a/docs/iris/src/index.rst b/docs/src/index.rst similarity index 100% rename from docs/iris/src/index.rst rename to docs/src/index.rst diff --git a/docs/iris/src/installing.rst b/docs/src/installing.rst similarity index 100% rename from docs/iris/src/installing.rst rename to docs/src/installing.rst diff --git a/docs/iris/src/spelling_allow.txt b/docs/src/spelling_allow.txt similarity index 100% rename from docs/iris/src/spelling_allow.txt rename to docs/src/spelling_allow.txt diff --git a/docs/iris/src/sphinxext/custom_class_autodoc.py b/docs/src/sphinxext/custom_class_autodoc.py similarity index 100% rename from docs/iris/src/sphinxext/custom_class_autodoc.py rename to docs/src/sphinxext/custom_class_autodoc.py diff --git a/docs/iris/src/sphinxext/custom_data_autodoc.py b/docs/src/sphinxext/custom_data_autodoc.py similarity index 100% rename from docs/iris/src/sphinxext/custom_data_autodoc.py rename to docs/src/sphinxext/custom_data_autodoc.py diff --git a/docs/iris/src/sphinxext/generate_package_rst.py b/docs/src/sphinxext/generate_package_rst.py similarity index 100% rename from docs/iris/src/sphinxext/generate_package_rst.py rename to docs/src/sphinxext/generate_package_rst.py diff --git a/docs/iris/src/techpapers/change_management.rst b/docs/src/techpapers/change_management.rst similarity index 100% rename from docs/iris/src/techpapers/change_management.rst rename to docs/src/techpapers/change_management.rst diff --git a/docs/iris/src/techpapers/index.rst b/docs/src/techpapers/index.rst similarity index 100% rename from docs/iris/src/techpapers/index.rst rename to docs/src/techpapers/index.rst diff --git a/docs/iris/src/techpapers/missing_data_handling.rst b/docs/src/techpapers/missing_data_handling.rst similarity index 100% rename from docs/iris/src/techpapers/missing_data_handling.rst rename to docs/src/techpapers/missing_data_handling.rst diff --git a/docs/iris/src/techpapers/um_files_loading.rst b/docs/src/techpapers/um_files_loading.rst similarity index 100% rename from docs/iris/src/techpapers/um_files_loading.rst rename to docs/src/techpapers/um_files_loading.rst diff --git a/docs/iris/src/userguide/change_management_goals.txt b/docs/src/userguide/change_management_goals.txt similarity index 100% rename from docs/iris/src/userguide/change_management_goals.txt rename to docs/src/userguide/change_management_goals.txt diff --git a/docs/iris/src/userguide/citation.rst b/docs/src/userguide/citation.rst similarity index 100% rename from docs/iris/src/userguide/citation.rst rename to docs/src/userguide/citation.rst diff --git a/docs/iris/src/userguide/code_maintenance.rst b/docs/src/userguide/code_maintenance.rst similarity index 100% rename from docs/iris/src/userguide/code_maintenance.rst rename to docs/src/userguide/code_maintenance.rst diff --git a/docs/iris/src/userguide/concat.png b/docs/src/userguide/concat.png similarity index 100% rename from docs/iris/src/userguide/concat.png rename to docs/src/userguide/concat.png diff --git a/docs/iris/src/userguide/concat.svg b/docs/src/userguide/concat.svg similarity index 100% rename from docs/iris/src/userguide/concat.svg rename to docs/src/userguide/concat.svg diff --git a/docs/iris/src/userguide/cube_diagram.dia b/docs/src/userguide/cube_diagram.dia similarity index 100% rename from docs/iris/src/userguide/cube_diagram.dia rename to docs/src/userguide/cube_diagram.dia diff --git a/docs/iris/src/userguide/cube_diagram.png b/docs/src/userguide/cube_diagram.png similarity index 100% rename from docs/iris/src/userguide/cube_diagram.png rename to docs/src/userguide/cube_diagram.png diff --git a/docs/iris/src/userguide/cube_maths.rst b/docs/src/userguide/cube_maths.rst similarity index 100% rename from docs/iris/src/userguide/cube_maths.rst rename to docs/src/userguide/cube_maths.rst diff --git a/docs/iris/src/userguide/cube_statistics.rst b/docs/src/userguide/cube_statistics.rst similarity index 100% rename from docs/iris/src/userguide/cube_statistics.rst rename to docs/src/userguide/cube_statistics.rst diff --git a/docs/iris/src/userguide/index.rst b/docs/src/userguide/index.rst similarity index 100% rename from docs/iris/src/userguide/index.rst rename to docs/src/userguide/index.rst diff --git a/docs/iris/src/userguide/interpolation_and_regridding.rst b/docs/src/userguide/interpolation_and_regridding.rst similarity index 100% rename from docs/iris/src/userguide/interpolation_and_regridding.rst rename to docs/src/userguide/interpolation_and_regridding.rst diff --git a/docs/iris/src/userguide/iris_cubes.rst b/docs/src/userguide/iris_cubes.rst similarity index 100% rename from docs/iris/src/userguide/iris_cubes.rst rename to docs/src/userguide/iris_cubes.rst diff --git a/docs/iris/src/userguide/loading_iris_cubes.rst b/docs/src/userguide/loading_iris_cubes.rst similarity index 100% rename from docs/iris/src/userguide/loading_iris_cubes.rst rename to docs/src/userguide/loading_iris_cubes.rst diff --git a/docs/iris/src/userguide/merge.png b/docs/src/userguide/merge.png similarity index 100% rename from docs/iris/src/userguide/merge.png rename to docs/src/userguide/merge.png diff --git a/docs/iris/src/userguide/merge.svg b/docs/src/userguide/merge.svg similarity index 100% rename from docs/iris/src/userguide/merge.svg rename to docs/src/userguide/merge.svg diff --git a/docs/iris/src/userguide/merge_and_concat.png b/docs/src/userguide/merge_and_concat.png similarity index 100% rename from docs/iris/src/userguide/merge_and_concat.png rename to docs/src/userguide/merge_and_concat.png diff --git a/docs/iris/src/userguide/merge_and_concat.rst b/docs/src/userguide/merge_and_concat.rst similarity index 100% rename from docs/iris/src/userguide/merge_and_concat.rst rename to docs/src/userguide/merge_and_concat.rst diff --git a/docs/iris/src/userguide/merge_and_concat.svg b/docs/src/userguide/merge_and_concat.svg similarity index 100% rename from docs/iris/src/userguide/merge_and_concat.svg rename to docs/src/userguide/merge_and_concat.svg diff --git a/docs/iris/src/userguide/multi_array.png b/docs/src/userguide/multi_array.png similarity index 100% rename from docs/iris/src/userguide/multi_array.png rename to docs/src/userguide/multi_array.png diff --git a/docs/iris/src/userguide/multi_array.svg b/docs/src/userguide/multi_array.svg similarity index 100% rename from docs/iris/src/userguide/multi_array.svg rename to docs/src/userguide/multi_array.svg diff --git a/docs/iris/src/userguide/multi_array_to_cube.png b/docs/src/userguide/multi_array_to_cube.png similarity index 100% rename from docs/iris/src/userguide/multi_array_to_cube.png rename to docs/src/userguide/multi_array_to_cube.png diff --git a/docs/iris/src/userguide/multi_array_to_cube.svg b/docs/src/userguide/multi_array_to_cube.svg similarity index 100% rename from docs/iris/src/userguide/multi_array_to_cube.svg rename to docs/src/userguide/multi_array_to_cube.svg diff --git a/docs/iris/src/userguide/navigating_a_cube.rst b/docs/src/userguide/navigating_a_cube.rst similarity index 100% rename from docs/iris/src/userguide/navigating_a_cube.rst rename to docs/src/userguide/navigating_a_cube.rst diff --git a/docs/iris/src/userguide/plotting_a_cube.rst b/docs/src/userguide/plotting_a_cube.rst similarity index 100% rename from docs/iris/src/userguide/plotting_a_cube.rst rename to docs/src/userguide/plotting_a_cube.rst diff --git a/docs/iris/src/userguide/plotting_examples/1d_quickplot_simple.py b/docs/src/userguide/plotting_examples/1d_quickplot_simple.py similarity index 100% rename from docs/iris/src/userguide/plotting_examples/1d_quickplot_simple.py rename to docs/src/userguide/plotting_examples/1d_quickplot_simple.py diff --git a/docs/iris/src/userguide/plotting_examples/1d_simple.py b/docs/src/userguide/plotting_examples/1d_simple.py similarity index 100% rename from docs/iris/src/userguide/plotting_examples/1d_simple.py rename to docs/src/userguide/plotting_examples/1d_simple.py diff --git a/docs/iris/src/userguide/plotting_examples/1d_with_legend.py b/docs/src/userguide/plotting_examples/1d_with_legend.py similarity index 100% rename from docs/iris/src/userguide/plotting_examples/1d_with_legend.py rename to docs/src/userguide/plotting_examples/1d_with_legend.py diff --git a/docs/iris/src/userguide/plotting_examples/brewer.py b/docs/src/userguide/plotting_examples/brewer.py similarity index 100% rename from docs/iris/src/userguide/plotting_examples/brewer.py rename to docs/src/userguide/plotting_examples/brewer.py diff --git a/docs/iris/src/userguide/plotting_examples/cube_blockplot.py b/docs/src/userguide/plotting_examples/cube_blockplot.py similarity index 100% rename from docs/iris/src/userguide/plotting_examples/cube_blockplot.py rename to docs/src/userguide/plotting_examples/cube_blockplot.py diff --git a/docs/iris/src/userguide/plotting_examples/cube_brewer_cite_contourf.py b/docs/src/userguide/plotting_examples/cube_brewer_cite_contourf.py similarity index 100% rename from docs/iris/src/userguide/plotting_examples/cube_brewer_cite_contourf.py rename to docs/src/userguide/plotting_examples/cube_brewer_cite_contourf.py diff --git a/docs/iris/src/userguide/plotting_examples/cube_brewer_contourf.py b/docs/src/userguide/plotting_examples/cube_brewer_contourf.py similarity index 100% rename from docs/iris/src/userguide/plotting_examples/cube_brewer_contourf.py rename to docs/src/userguide/plotting_examples/cube_brewer_contourf.py diff --git a/docs/iris/src/userguide/plotting_examples/cube_contour.py b/docs/src/userguide/plotting_examples/cube_contour.py similarity index 100% rename from docs/iris/src/userguide/plotting_examples/cube_contour.py rename to docs/src/userguide/plotting_examples/cube_contour.py diff --git a/docs/iris/src/userguide/plotting_examples/cube_contourf.py b/docs/src/userguide/plotting_examples/cube_contourf.py similarity index 100% rename from docs/iris/src/userguide/plotting_examples/cube_contourf.py rename to docs/src/userguide/plotting_examples/cube_contourf.py diff --git a/docs/iris/src/userguide/real_and_lazy_data.rst b/docs/src/userguide/real_and_lazy_data.rst similarity index 100% rename from docs/iris/src/userguide/real_and_lazy_data.rst rename to docs/src/userguide/real_and_lazy_data.rst diff --git a/docs/iris/src/userguide/regridding_plots/interpolate_column.py b/docs/src/userguide/regridding_plots/interpolate_column.py similarity index 100% rename from docs/iris/src/userguide/regridding_plots/interpolate_column.py rename to docs/src/userguide/regridding_plots/interpolate_column.py diff --git a/docs/iris/src/userguide/regridding_plots/regridded_to_global.py b/docs/src/userguide/regridding_plots/regridded_to_global.py similarity index 100% rename from docs/iris/src/userguide/regridding_plots/regridded_to_global.py rename to docs/src/userguide/regridding_plots/regridded_to_global.py diff --git a/docs/iris/src/userguide/regridding_plots/regridded_to_global_area_weighted.py b/docs/src/userguide/regridding_plots/regridded_to_global_area_weighted.py similarity index 100% rename from docs/iris/src/userguide/regridding_plots/regridded_to_global_area_weighted.py rename to docs/src/userguide/regridding_plots/regridded_to_global_area_weighted.py diff --git a/docs/iris/src/userguide/regridding_plots/regridded_to_rotated.py b/docs/src/userguide/regridding_plots/regridded_to_rotated.py similarity index 100% rename from docs/iris/src/userguide/regridding_plots/regridded_to_rotated.py rename to docs/src/userguide/regridding_plots/regridded_to_rotated.py diff --git a/docs/iris/src/userguide/regridding_plots/regridding_plot.py b/docs/src/userguide/regridding_plots/regridding_plot.py similarity index 100% rename from docs/iris/src/userguide/regridding_plots/regridding_plot.py rename to docs/src/userguide/regridding_plots/regridding_plot.py diff --git a/docs/iris/src/userguide/saving_iris_cubes.rst b/docs/src/userguide/saving_iris_cubes.rst similarity index 100% rename from docs/iris/src/userguide/saving_iris_cubes.rst rename to docs/src/userguide/saving_iris_cubes.rst diff --git a/docs/iris/src/userguide/subsetting_a_cube.rst b/docs/src/userguide/subsetting_a_cube.rst similarity index 100% rename from docs/iris/src/userguide/subsetting_a_cube.rst rename to docs/src/userguide/subsetting_a_cube.rst diff --git a/docs/iris/src/whatsnew/1.0.rst b/docs/src/whatsnew/1.0.rst similarity index 100% rename from docs/iris/src/whatsnew/1.0.rst rename to docs/src/whatsnew/1.0.rst diff --git a/docs/iris/src/whatsnew/1.1.rst b/docs/src/whatsnew/1.1.rst similarity index 100% rename from docs/iris/src/whatsnew/1.1.rst rename to docs/src/whatsnew/1.1.rst diff --git a/docs/iris/src/whatsnew/1.10.rst b/docs/src/whatsnew/1.10.rst similarity index 100% rename from docs/iris/src/whatsnew/1.10.rst rename to docs/src/whatsnew/1.10.rst diff --git a/docs/iris/src/whatsnew/1.11.rst b/docs/src/whatsnew/1.11.rst similarity index 100% rename from docs/iris/src/whatsnew/1.11.rst rename to docs/src/whatsnew/1.11.rst diff --git a/docs/iris/src/whatsnew/1.12.rst b/docs/src/whatsnew/1.12.rst similarity index 100% rename from docs/iris/src/whatsnew/1.12.rst rename to docs/src/whatsnew/1.12.rst diff --git a/docs/iris/src/whatsnew/1.13.rst b/docs/src/whatsnew/1.13.rst similarity index 100% rename from docs/iris/src/whatsnew/1.13.rst rename to docs/src/whatsnew/1.13.rst diff --git a/docs/iris/src/whatsnew/1.2.rst b/docs/src/whatsnew/1.2.rst similarity index 100% rename from docs/iris/src/whatsnew/1.2.rst rename to docs/src/whatsnew/1.2.rst diff --git a/docs/iris/src/whatsnew/1.3.rst b/docs/src/whatsnew/1.3.rst similarity index 100% rename from docs/iris/src/whatsnew/1.3.rst rename to docs/src/whatsnew/1.3.rst diff --git a/docs/iris/src/whatsnew/1.4.rst b/docs/src/whatsnew/1.4.rst similarity index 100% rename from docs/iris/src/whatsnew/1.4.rst rename to docs/src/whatsnew/1.4.rst diff --git a/docs/iris/src/whatsnew/1.5.rst b/docs/src/whatsnew/1.5.rst similarity index 100% rename from docs/iris/src/whatsnew/1.5.rst rename to docs/src/whatsnew/1.5.rst diff --git a/docs/iris/src/whatsnew/1.6.rst b/docs/src/whatsnew/1.6.rst similarity index 100% rename from docs/iris/src/whatsnew/1.6.rst rename to docs/src/whatsnew/1.6.rst diff --git a/docs/iris/src/whatsnew/1.7.rst b/docs/src/whatsnew/1.7.rst similarity index 100% rename from docs/iris/src/whatsnew/1.7.rst rename to docs/src/whatsnew/1.7.rst diff --git a/docs/iris/src/whatsnew/1.8.rst b/docs/src/whatsnew/1.8.rst similarity index 100% rename from docs/iris/src/whatsnew/1.8.rst rename to docs/src/whatsnew/1.8.rst diff --git a/docs/iris/src/whatsnew/1.9.rst b/docs/src/whatsnew/1.9.rst similarity index 100% rename from docs/iris/src/whatsnew/1.9.rst rename to docs/src/whatsnew/1.9.rst diff --git a/docs/iris/src/whatsnew/2.0.rst b/docs/src/whatsnew/2.0.rst similarity index 100% rename from docs/iris/src/whatsnew/2.0.rst rename to docs/src/whatsnew/2.0.rst diff --git a/docs/iris/src/whatsnew/2.1.rst b/docs/src/whatsnew/2.1.rst similarity index 100% rename from docs/iris/src/whatsnew/2.1.rst rename to docs/src/whatsnew/2.1.rst diff --git a/docs/iris/src/whatsnew/2.2.rst b/docs/src/whatsnew/2.2.rst similarity index 100% rename from docs/iris/src/whatsnew/2.2.rst rename to docs/src/whatsnew/2.2.rst diff --git a/docs/iris/src/whatsnew/2.3.rst b/docs/src/whatsnew/2.3.rst similarity index 99% rename from docs/iris/src/whatsnew/2.3.rst rename to docs/src/whatsnew/2.3.rst index 2509242c05..693b67efba 100644 --- a/docs/iris/src/whatsnew/2.3.rst +++ b/docs/src/whatsnew/2.3.rst @@ -238,7 +238,7 @@ Documentation ============= * Adopted a - `new colour logo for Iris `_ + `new colour logo for Iris `_ * Added a gallery example showing how to concatenate NEMO ocean model data, see :ref:`sphx_glr_generated_gallery_oceanography_plot_load_nemo.py`. diff --git a/docs/iris/src/whatsnew/2.4.rst b/docs/src/whatsnew/2.4.rst similarity index 100% rename from docs/iris/src/whatsnew/2.4.rst rename to docs/src/whatsnew/2.4.rst diff --git a/docs/iris/src/whatsnew/3.0.1.rst b/docs/src/whatsnew/3.0.1.rst similarity index 100% rename from docs/iris/src/whatsnew/3.0.1.rst rename to docs/src/whatsnew/3.0.1.rst diff --git a/docs/iris/src/whatsnew/3.0.rst b/docs/src/whatsnew/3.0.rst similarity index 100% rename from docs/iris/src/whatsnew/3.0.rst rename to docs/src/whatsnew/3.0.rst diff --git a/docs/iris/src/whatsnew/images/notebook_repr.png b/docs/src/whatsnew/images/notebook_repr.png similarity index 100% rename from docs/iris/src/whatsnew/images/notebook_repr.png rename to docs/src/whatsnew/images/notebook_repr.png diff --git a/docs/iris/src/whatsnew/images/transverse_merc.png b/docs/src/whatsnew/images/transverse_merc.png similarity index 100% rename from docs/iris/src/whatsnew/images/transverse_merc.png rename to docs/src/whatsnew/images/transverse_merc.png diff --git a/docs/iris/src/whatsnew/index.rst b/docs/src/whatsnew/index.rst similarity index 100% rename from docs/iris/src/whatsnew/index.rst rename to docs/src/whatsnew/index.rst diff --git a/docs/iris/src/whatsnew/latest.rst b/docs/src/whatsnew/latest.rst similarity index 87% rename from docs/iris/src/whatsnew/latest.rst rename to docs/src/whatsnew/latest.rst index 618eeb10d6..a63c083474 100644 --- a/docs/iris/src/whatsnew/latest.rst +++ b/docs/src/whatsnew/latest.rst @@ -69,12 +69,15 @@ This document explains the changes made to Iris for this release 📚 Documentation ================ -#. `@rcomer`_ updated the "Seasonal ensemble model plots" Gallery example. (:pull:`3933`) +#. `@rcomer`_ updated the "Seasonal ensemble model plots" Gallery example. + (:pull:`3933`) -#. `@MHBalsmeier`_ described non-conda installation on Debian-based distros. (:pull:`3958`) +#. `@MHBalsmeier`_ described non-conda installation on Debian-based distros. + (:pull:`3958`) -#. `@bjlittle`_ clarified in the doc-string that :class:`~iris.coords.Coord` is now an `abstract base class`_ of - coordinates since ``v3.0.0``, and it is **not** possible to create an instance of it. (:pull:`3971`) +#. `@bjlittle`_ clarified in the doc-string that :class:`~iris.coords.Coord` + is now an `abstract base class`_ of coordinates since ``v3.0.0``, and it + is **not** possible to create an instance of it. (:pull:`3971`) 💼 Internal @@ -82,8 +85,12 @@ This document explains the changes made to Iris for this release #. `@rcomer`_ removed an old unused test file. (:pull:`3913`) +#. `@tkknight`_ moved the ``docs/iris`` directory to be in the parent + directory ``docs``. (:pull:`3975`) + #. `@jamesp`_ updated a test to the latest numpy version (:pull:`3977`) + .. comment Whatsnew author names (@github name) in alphabetical order. Note that, core dev names are automatically included by the common_links.inc: diff --git a/docs/iris/src/whatsnew/latest.rst.template b/docs/src/whatsnew/latest.rst.template similarity index 100% rename from docs/iris/src/whatsnew/latest.rst.template rename to docs/src/whatsnew/latest.rst.template diff --git a/lib/iris/tests/test_coding_standards.py b/lib/iris/tests/test_coding_standards.py index 79dff535eb..1ab39330ef 100644 --- a/lib/iris/tests/test_coding_standards.py +++ b/lib/iris/tests/test_coding_standards.py @@ -105,12 +105,11 @@ def test_license_headers(self): "noxfile.py", "build/*", "dist/*", - "docs/iris/gallery_code/*/*.py", - "docs/iris/src/developers_guide/documenting/*.py", - "docs/iris/src/userguide/plotting_examples/*.py", - "docs/iris/src/userguide/regridding_plots/*.py", - "docs/iris/src/developers_guide/gitwash_dumper.py", - "docs/iris/src/_build/*", + "docs/gallery_code/*/*.py", + "docs/src/developers_guide/documenting/*.py", + "docs/src/userguide/plotting_examples/*.py", + "docs/src/userguide/regridding_plots/*.py", + "docs/src/_build/*", "lib/iris/analysis/_scipy_interpolate.py", "lib/iris/fileformats/_pyke_rules/*", ) diff --git a/noxfile.py b/noxfile.py index 7bfcc73dd7..fc6175bdf0 100644 --- a/noxfile.py +++ b/noxfile.py @@ -250,7 +250,7 @@ def doctest(session): cache_cartopy(session) session.install("--no-deps", "--editable", ".") - session.cd("docs/iris") + session.cd("docs") session.run( "make", "clean", @@ -298,7 +298,7 @@ def linkcheck(session): cache_cartopy(session) session.install("--no-deps", "--editable", ".") - session.cd("docs/iris") + session.cd("docs") session.run( "make", "clean",