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

documentation versioning #17

Closed
oliver-sanders opened this issue May 28, 2019 · 3 comments
Closed

documentation versioning #17

oliver-sanders opened this issue May 28, 2019 · 3 comments
Assignees
Labels
content Addition or modification of documentation

Comments

@oliver-sanders
Copy link
Member

We should make the documentation available for multiple versions of Cylc and adopt a build directory structure similar to Rose.

Now that we have split Cylc into multiple decoupled components this is a little awkward but I would suggest the Cylc Flow version is the one which matters for the documentation.

Versioning documentation is pretty simple, change the directory structure so that documentation is built under a version directory, in Rose we have:

sphinx/
    # the documentation source files
    conf.py
    index.rst
    ...
doc/
    # the built documentation
    formats.json  # file listing versions and formats for the theme to present as options.
    2019.01.0/
        html/
            index.html
            ...
        slides/
            index.html
            ...
        pdf/
            index.html
            tutorial.pdf
            ...
    2018.06.0/
         ...
@oliver-sanders oliver-sanders added the content Addition or modification of documentation label May 28, 2019
@kinow
Copy link
Member

kinow commented May 28, 2019

👍 and I think using Setuptools is not necessary, unless others find it useful. As this repo will start blank with the old content. The whole build structure can be make, setuptools, ant, etc. Whatever works the best here.

@oliver-sanders
Copy link
Member Author

The whole build structure can be make, setuptools, ant, etc

The standard approach is to use the default Sphinx makefile produced by sphinx quickstart. We shouldn't need to adapt it too much.

@oliver-sanders
Copy link
Member Author

closed by #26

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Addition or modification of documentation
Projects
None yet
Development

No branches or pull requests

2 participants