CIL icon indicating copy to clipboard operation
CIL copied to clipboard

docs versions + updates

Open casperdcl opened this issue 2 years ago • 2 comments

Provide multiple (not just latest) docs versions

  • [x] use/fix https://cil.readthedocs.io #1693
  • [x] drop/update GH conda docs builds #1679
    • ~redirect https://tomographicimaging.github.io/CIL/{,nightly} -> https://cil.readthedocs.io~
    • closes #1430
    • closes #1380
    • fix/update sphinx (closes #1597)
  • [x] multiple versions #1679
    • [x] latest/nightly/master, vM.m.p
    • [x] fix version switcher .html suffix #1797
    • [ ] delete fork after upstream release https://github.com/pydata/pydata-sphinx-theme/pull/1795 i.e. pydata-sphinx-theme>=0.15.3
  • [ ] meta-docs #1830
  • [ ] developer vs user docs (e.g. unhide _private methods)
  • [x] CIL-Demos ipynb rendering #1690
  • [ ] add UML #1688
  • [ ] link to GitHub source code rather than render source code statically
  • [x] create a nicer landing page #1699

casperdcl avatar Nov 21 '23 14:11 casperdcl

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.

gfardell avatar Nov 21 '23 15:11 gfardell

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

casperdcl avatar Nov 22 '23 13:11 casperdcl