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

use cylc sphinx extensions repo #2374

Merged
merged 5 commits into from
Aug 13, 2019

Conversation

oliver-sanders
Copy link
Member

@oliver-sanders oliver-sanders commented Jul 31, 2019

  • Remove cylc tutorial (it is in cylc-doc now)
    • Bump this back until the Cylc Docs (with the tutorial) are deployed.
  • Migrate Sphinx extensions common to Rose & Cylc to https://github.com/cylc/cylc-sphinx-extensions
  • Package rose documentation.

@oliver-sanders
Copy link
Member Author

oliver-sanders commented Jul 31, 2019

Waiting on cylc/cylc-sphinx-extensions#2

'cylc-sphinx-extensions'
' @ '
'git+https://github.com/cylc/cylc-sphinx-extensions.git'
'#egg=metomi_rose[all]'
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Install direct from GitHub for now, see also cylc/cylc-sphinx-extensions#3

@oliver-sanders oliver-sanders changed the title migrate cylc tutorial and use cylc sphinx extensions repo use cylc sphinx extensions repo Aug 5, 2019
@oliver-sanders oliver-sanders marked this pull request as ready for review August 5, 2019 13:50
Copy link
Contributor

@sadielbartholomew sadielbartholomew left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Otherwise looks good & builds successfully, however I got a set of corresponding build warnings relating to finding resources from the installed cylc-sphinx-extensions repo (see sub-comment) which should be addressed.

We should also update the 'Documentation builder' specification for rose check-software accordingly, for example to include cylc-sphinx-extensions (unless we plan to deprecate that command, I have no idea about the plans for it?), though that could be a follow-on PR?

sphinx/conf.py Show resolved Hide resolved
Copy link
Contributor

@sadielbartholomew sadielbartholomew left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feedback addressed; resolved when the branch from cylc/cylc-sphinx-extensions#7 response PR is used (I will merge that one now too).

@sadielbartholomew
Copy link
Contributor

(Two approvals is standard, & @wxtim is on leave anyway so it would be days before any feedback from him, so it is safe & pragmatic to merge now.)

@sadielbartholomew sadielbartholomew merged commit 918c521 into metomi:master Aug 13, 2019
@oliver-sanders oliver-sanders deleted the migrate-cylc-tutorial branch August 14, 2019 08:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants