-
Notifications
You must be signed in to change notification settings - Fork 19
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
consolidate rose & cylc sphinx extensions #39
Comments
+1 for both removing duplicate, and also for adding dependency to cylc-flow from rose. I think it makes sense this direction, as Rose uses Cylc, but not the other way. |
OK, done some quick thinking on this. Sphinx extensions can have:
Because the stuff is spread in different places and because the Rose docs are not a subset of the Cylc docs it's kinda hard to import Cylc Sphinx extensions from Rose. Possible solution, put the sphinx extensions in yet another repository and then either:
I guess one "super" repository to contain all of the extensions would suffice, no real need to break things down further from there. It does mean yet another repository, yet another place to document issues but it would cut down on duplication. @kinow thoughts? |
+1
Makes sense to me. In the end this extra repository would make our work easier by maintaining it in a single place. And thanks for the explanation about the Sphinx part. Yesterday I tried to deploy our cylc-doc to a GitHub pages under my user account, and it failed to load the assets as they were under |
So the whole underscore thing comes from Jekyll which is the system GitHub uses to generate static sites for GH pages. TLDR stuff beginning with an underscore has special meaning in Jekyll. The easiest solution is to maunually include these files in the Jekyll PS: |
No worries. I think we will deploy it to Read The Docs? So it shouldn't be a problem I think? |
OK, work started https://github.com/cylc/cylc-sphinx-extensions |
Part 1: Copy extensions to new repository cylc/cylc-sphinx-extensions#2 Need volunteers to review, as it's a new repo I can't assign... |
You should be able to assign now (thanks to @hjoliver !) |
Done in several earlier PRs. |
Remove duplicate code by making one documentation system (presumably Rose) dependent on the other (Cylc?).
Example duplication,
src/ext/cylc_lang,py
Cylc language lexer.[update]: see the sister PR https://github.com/metomi/rose/pull/2374/files
The text was updated successfully, but these errors were encountered: