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

docs versions + updates #1579

Open
8 of 16 tasks
casperdcl opened this issue Nov 21, 2023 · 2 comments
Open
8 of 16 tasks

docs versions + updates #1579

casperdcl opened this issue Nov 21, 2023 · 2 comments
Assignees
Labels

Comments

@casperdcl
Copy link
Member

casperdcl commented Nov 21, 2023

Provide multiple (not just latest) docs versions

@casperdcl casperdcl self-assigned this Nov 21, 2023
@gfardell
Copy link
Member

I think we want 'https://tomographicimaging.github.io/CIL' to be the CIL entry point. Currently that's probably the github CIL readme.md, but we also have a page on https://ccpi.ac.uk/cil/ . This would mean having pages introducing CIL, installation instructions, code documentation (should we have user and developer versions too?), tutorials and notebooks, and a contribution guideline. Similar to this project from @jakobsj https://cuqi-dtu.github.io/CUQIpy/

We had a lot of feedback last week on having our information split across multiple sites so I'd be nervous about bringing readthedocs in to it too. I think this is something that will be discussed at vthe next developer meeting.

@casperdcl
Copy link
Member Author

casperdcl commented Nov 22, 2023

The thing is readthedocs gives us versioning for free. If we want that then it's better to migrate away from gh-pages... #1673

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
No open projects
Status: WIP
Development

No branches or pull requests

3 participants