Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

moved docs dir and updated references to it #3975

Merged
merged 5 commits into from
Feb 3, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .cirrus.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down Expand Up @@ -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


Expand Down Expand Up @@ -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


Expand Down Expand Up @@ -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}
Expand Down
2 changes: 1 addition & 1 deletion .flake8
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ exclude =
.eggs,
build,
compiled_krb,
docs/iris/src/sphinxext/*,
docs/src/sphinxext/*,
tools/*,
#
# ignore auto-generated files
Expand Down
6 changes: 3 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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
*~
Expand Down
2 changes: 1 addition & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion CHANGES
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
2 changes: 1 addition & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<h1 align="center">
<a href="https://scitools.org.uk/iris/docs/latest/">
<img src="docs/iris/src/_static/iris-logo-title.png" alt="Iris" width="300"></a><br>
<img src="docs/src/_static/iris-logo-title.png" alt="Iris" width="300"></a><br>
</h1>


Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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::
Expand Down Expand Up @@ -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:
Expand All @@ -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:
Expand All @@ -137,20 +137,20 @@ 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
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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ Documentation
=============

* Adopted a
`new colour logo for Iris <https://github.com/SciTools/iris/blob/master/docs/iris/src/_static/Iris7_1_trim_100.png>`_
`new colour logo for Iris <https://github.com/SciTools/iris/blob/master/docs/src/_static/Iris7_1_trim_100.png>`_

* Added a gallery example showing how to concatenate NEMO ocean model data,
see :ref:`sphx_glr_generated_gallery_oceanography_plot_load_nemo.py`.
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
15 changes: 11 additions & 4 deletions docs/iris/src/whatsnew/latest.rst → docs/src/whatsnew/latest.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,21 +69,28 @@ 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
===========

#. `@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:
Expand Down
11 changes: 5 additions & 6 deletions lib/iris/tests/test_coding_standards.py
Original file line number Diff line number Diff line change
Expand Up @@ -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/*",
)
Expand Down
4 changes: 2 additions & 2 deletions noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down