Merge pull request #3181 from hjoliver/mv-docs-other-repo

Move documentation to new cylc/cylc-doc repo.

.github/PULL_REQUEST_TEMPLATE.md

@@ -17,3 +17,6 @@ COMMENT: choose one:
 COMMENT: choose one:
 - [ ] Includes an appropriate entry in the release change log `CHANGES.md`.
 - [ ] No change log entry required (e.g. change is small or internal only).
+COMMENT: choose one:
+- [ ] I have opened a corresponding documentation PR at cylc/cylc-doc#XXXX.
+- [ ] No documentation update required for this change.

.travis.yml

@@ -105,11 +105,3 @@ jobs:
 
   # TODO: run shortlist of regression tests with the
   #       least contemporary Python version
-
-  # build documentation
-  - stage: documentation
-    python: "3.7"
-    install:
-      - .travis/install.sh docs
-    script:
-      - python setup.py build_sphinx

.travis/install.sh

@@ -32,12 +32,6 @@ if grep 'unit-tests' <<< "${args[@]}"; then
     sudo apt-get install shellcheck
 fi
 
-# install dependencies required for building documentation
-if grep 'docs' <<< "${args[@]}"; then
-    # for PDF output via LaTeX builder
-    sudo apt-get install texlive-latex-base
-fi
-
 pip install -e ."[all]"
 
 # configure local SSH for Cylc jobs

CHANGES.md

@@ -185,6 +185,9 @@ invalid cylc command is used (instead of a ValueError).
 
 ### Documentation
 
+[#3181](https://github.com/cylc/cylc-flow/pull/3181) - moved documentation to
+the new cylc/cylc-doc repository.
+
 [#3025](https://github.com/cylc/cylc-flow/pull/3025) - fix dev-suites
 reference in docs (now in examples).
 

INSTALL.md

@@ -1,7 +1,8 @@
 # Cylc: Quick Installation Guide
 
 **See [The Cylc User Guide](https://cylc.github.io/documentation.html) for
-more detailed information.**
+more detailed information.**  Cylc documentation is now maintained in the
+cylc/cylc-doc repository on GitHub.
 
 Cylc must be installed on suite and task job hosts. Third-party dependencies
 (below) are not required on job hosts.

bin/cylc-check-software

@@ -53,7 +53,6 @@ latter grouped as Python or 'other'. 'opt_spec' item format:
 req_py_ver_range = ((3,7),)
 opt_spec = {
     'EmPy': [(3, 3, 4), 'TEMPLATING', 'PY'],
-    'sphinx': [(1, 5, 3), 'HTMLDOCS', 'PY'],
 }
 
 # All possible module reqs to accept as arguments, as above or all lower case.
@@ -64,7 +63,6 @@ upper_case_conv = dict(
 # Package-dep. functionality dict; item format <FUNC TAG>: <FULL DESCRIPTION>
 func_tags_and_text = {
     'TEMPLATING': 'configuration templating',
-    'HTMLDOCS': 'HTML documentation',
 }
 
 # Initialise results dict

cylc/flow/etc/conda-environment.yaml

@@ -8,7 +8,6 @@ dependencies:
   - python-jose
   - colorama
   - jinja2
-  - sphinx
   - pytest
   - pycodestyle
   - coverage

doc/README.md

@@ -0,0 +1 @@
+The Cylc User Guide has been moved to the `cylc/cylc-doc` repository.