-
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
Transfer docs from cylc-flow repo. #3
Conversation
My Answers
I don't think it matters much how we build the docs. The "standard" way to build Sphinx documentation is via the
This repo must have a dependence on Cylc Flow in order to auto-document from docstrings etc. I think the Cylc documentation should probably be versioned to the Cylc Flow version (see #17). We could just hardcode the Cylc Flow version in the The other alternative would be using the On a side note we need to get rid of the command which documents the CLI (perhaps with cylc/cylc-flow#2972) |
I started a PR to fix the build for the docs as on |
@sadielbartholomew - I'd like to get this merged soon. We can tweak doc build and dependency specification later as needed (do you agree @oliver-sanders?) For the moment we can put reminder Issues up on this repo, for stuff to do once the docs have moved here. |
Sure, thanks @hjoliver. I'll close that PR, in that case, & once the docs are moved over have a look to see what may still be relevant from it & open up a new PR on the docs repo if it seems suitable. |
Seems fine to me, the packaging is broken, have put up a PR to fix: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For the build to pass in my local environment, I needed the changes in @oliver-sanders ' pending pull request. But after that the build passed.
@oliver-sanders ' pull request also needed some things amended, including to use the version 8.0a1
, which is current development version, and not released to PYPI. That's a bit confusing as the current documentation relies on cylc.flow
from 8.0a1
, but it uses 8.0a0
as current version, as below.
But we can fix that later with a new alpha release. Left one question about a command imported to this PR. But I don't see anything as a blocker, as this is not intended to be the perfect & final version, but instead a step in migrating the old documentation from cylc-flow
to this new repo. So +1 to merge it. Better if we could include @oliver-sanders ' changes, but if not we can re-open his PR directly against this repository after the merge. Either way is fine for me 👍
Thanks!
Transfer docs from cylc flow
Merged in @oliver-sanders PR. |
* Update deploy.yml * Update nightly.yml * Update test.yml * Update test_tutorial_workflow.yml
Close #2
This takes the whole doc directory from cylc/cylc-flow, and relevant bits of setup.py and travis config ... which will probably require some tweaking, or maybe travis is not appropriate here at all given issues related to dependence on other components (below)?
Questions
our docs are sphinx generated, which suggests that Python
setup.py
is still appropriate for this repo?but how to manage dependence on cylc/cylc-flow ? - needed to generate the command transcripts included in the user guide?