Skip to content

Commit ea49375

Browse files
authored
moved docs dir and updated references to it (SciTools#3975)
* moved docs dir and updated references to it * added whatsnew * updated more docs directory references * updated docs dir references
1 parent 79d636e commit ea49375

File tree

187 files changed

+49
-43
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

187 files changed

+49
-43
lines changed

.cirrus.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ linux_minimal_task:
106106
<< : *LINUX_TASK_TEMPLATE
107107
tests_script:
108108
- echo "[Resources]" > ${SITE_CFG}
109-
- echo "doc_dir = ${CIRRUS_WORKING_DIR}/docs/iris" >> ${SITE_CFG}
109+
- echo "doc_dir = ${CIRRUS_WORKING_DIR}/docs" >> ${SITE_CFG}
110110
- nox --session tests
111111

112112

@@ -136,7 +136,7 @@ linux_task:
136136
tests_script:
137137
- echo "[Resources]" > ${SITE_CFG}
138138
- echo "test_data_dir = ${IRIS_TEST_DATA_DIR}/test_data" >> ${SITE_CFG}
139-
- echo "doc_dir = ${CIRRUS_WORKING_DIR}/docs/iris" >> ${SITE_CFG}
139+
- echo "doc_dir = ${CIRRUS_WORKING_DIR}/docs" >> ${SITE_CFG}
140140
- nox --session tests
141141

142142

@@ -166,7 +166,7 @@ gallery_task:
166166
tests_script:
167167
- echo "[Resources]" > ${SITE_CFG}
168168
- echo "test_data_dir = ${IRIS_TEST_DATA_DIR}/test_data" >> ${SITE_CFG}
169-
- echo "doc_dir = ${CIRRUS_WORKING_DIR}/docs/iris" >> ${SITE_CFG}
169+
- echo "doc_dir = ${CIRRUS_WORKING_DIR}/docs" >> ${SITE_CFG}
170170
- nox --session gallery
171171

172172

@@ -197,7 +197,7 @@ doctest_task:
197197
tests_script:
198198
- echo "[Resources]" > ${SITE_CFG}
199199
- echo "test_data_dir = ${IRIS_TEST_DATA_DIR}/test_data" >> ${SITE_CFG}
200-
- echo "doc_dir = ${CIRRUS_WORKING_DIR}/docs/iris" >> ${SITE_CFG}
200+
- echo "doc_dir = ${CIRRUS_WORKING_DIR}/docs" >> ${SITE_CFG}
201201
- mkdir -p ${MPL_RC_DIR}
202202
- echo "backend : agg" > ${MPL_RC_FILE}
203203
- echo "image.cmap : viridis" >> ${MPL_RC_FILE}

.flake8

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ exclude =
3030
.eggs,
3131
build,
3232
compiled_krb,
33-
docs/iris/src/sphinxext/*,
33+
docs/src/sphinxext/*,
3434
tools/*,
3535
#
3636
# ignore auto-generated files

.gitignore

+3-3
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,11 @@ lib/iris/tests/results/imagerepo.lock
5656
*.cover
5757

5858
# Auto generated documentation files
59-
docs/iris/src/_build/*
60-
docs/iris/src/generated
59+
docs/src/_build/*
60+
docs/src/generated
6161

6262
# Example test results
63-
docs/iris/iris_image_test_output/
63+
docs/iris_image_test_output/
6464

6565
# Created by editiors
6666
*~

.readthedocs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ conda:
77
environment: requirements/ci/readthedocs.yml
88

99
sphinx:
10-
configuration: docs/iris/src/conf.py
10+
configuration: docs/src/conf.py
1111
fail_on_warning: false
1212

1313
python:

CHANGES

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
This file is no longer updated and is provided for historical purposes only.
2-
Please see docs/iris/src/whatsnew/ for a changelog.
2+
Please see docs/src/whatsnew/ for a changelog.
33

44

55
Release 1.4 (14 June 2013)

MANIFEST.in

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ include requirements/*.txt
1111

1212
# File required to build docs
1313
recursive-include docs Makefile *.js *.png *.py *.rst
14-
prune docs/iris/build
14+
prune docs/build
1515

1616
# Files required to build std_names module
1717
include tools/generate_std_names.py

README.md

+1-1

docs/iris/Makefile docs/Makefile

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.

docs/iris/src/developers_guide/contributing_documentation.rst docs/src/developers_guide/contributing_documentation.rst

+10-10

docs/iris/src/developers_guide/contributing_graphics_tests.rst docs/src/developers_guide/contributing_graphics_tests.rst

+1-1

docs/iris/src/developers_guide/documenting/whats_new_contributions.rst docs/src/developers_guide/documenting/whats_new_contributions.rst

+1-1

docs/iris/src/developers_guide/release.rst docs/src/developers_guide/release.rst

+6-6
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.

docs/iris/src/whatsnew/2.3.rst docs/src/whatsnew/2.3.rst

+1-1

docs/iris/src/whatsnew/latest.rst docs/src/whatsnew/latest.rst

+11-4

lib/iris/tests/test_coding_standards.py

+5-6
Original file line numberDiff line numberDiff line change
@@ -105,12 +105,11 @@ def test_license_headers(self):
105105
"noxfile.py",
106106
"build/*",
107107
"dist/*",
108-
"docs/iris/gallery_code/*/*.py",
109-
"docs/iris/src/developers_guide/documenting/*.py",
110-
"docs/iris/src/userguide/plotting_examples/*.py",
111-
"docs/iris/src/userguide/regridding_plots/*.py",
112-
"docs/iris/src/developers_guide/gitwash_dumper.py",
113-
"docs/iris/src/_build/*",
108+
"docs/gallery_code/*/*.py",
109+
"docs/src/developers_guide/documenting/*.py",
110+
"docs/src/userguide/plotting_examples/*.py",
111+
"docs/src/userguide/regridding_plots/*.py",
112+
"docs/src/_build/*",
114113
"lib/iris/analysis/_scipy_interpolate.py",
115114
"lib/iris/fileformats/_pyke_rules/*",
116115
)

noxfile.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ def doctest(session):
250250

251251
cache_cartopy(session)
252252
session.install("--no-deps", "--editable", ".")
253-
session.cd("docs/iris")
253+
session.cd("docs")
254254
session.run(
255255
"make",
256256
"clean",
@@ -298,7 +298,7 @@ def linkcheck(session):
298298

299299
cache_cartopy(session)
300300
session.install("--no-deps", "--editable", ".")
301-
session.cd("docs/iris")
301+
session.cd("docs")
302302
session.run(
303303
"make",
304304
"clean",

0 commit comments

Comments
 (0)