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

Move documentation to new cylc/cylc-doc repo. #3181

Merged
merged 4 commits into from
Jun 13, 2019
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
3 changes: 3 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
kinow marked this conversation as resolved.
Show resolved Hide resolved
8 changes: 0 additions & 8 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
6 changes: 0 additions & 6 deletions .travis/install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
3 changes: 2 additions & 1 deletion INSTALL.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 0 additions & 2 deletions bin/cylc-check-software
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down
1 change: 0 additions & 1 deletion cylc/flow/etc/conda-environment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ dependencies:
- python-jose
- colorama
- jinja2
- sphinx
- pytest
- pycodestyle
- coverage
Expand Down
177 changes: 0 additions & 177 deletions doc/Makefile

This file was deleted.

1 change: 1 addition & 0 deletions doc/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The Cylc User Guide has been moved to the `cylc/cylc-doc` repository.
37 changes: 0 additions & 37 deletions doc/joss-paper/codemeta.json

This file was deleted.

9 changes: 0 additions & 9 deletions doc/joss-paper/paper.bib

This file was deleted.

94 changes: 0 additions & 94 deletions doc/joss-paper/paper.md

This file was deleted.

Loading