SciKit-Surgery / scikit-surgery

SciKit-Surgery - Compact Libraries for Surgical Navigation
http://scikit-surgery.github.io/scikit-surgery/
Other
39 stars 11 forks source link

Modify default Sphinx page #45

Closed thompson318 closed 4 years ago

thompson318 commented 4 years ago

In GitLab by @ThomasDowrick on Feb 5, 2019, 08:35

All of the RTD pages have two entries in the table of contents, requirements, and a PyCharm guide: image

I think we should remove these, as they don't link to anything useful. Ideally, it should be showing a list of Module classes/functions etc. @MattClarkson @StephenThompson

thompson318 commented 4 years ago

In GitLab by @MattClarkson on Feb 5, 2019, 08:38

Hold on. I'd prefer a list of the modules/classes/functions. Tom Doel originally put the PyCharm bit on the front, which got factored into a separate page, which is fair enough. But most people wont read that page, as you can google for other pages on how to use PyCharm. But we SHOULD/MUST have a requirements page. Steve put effort into that.

thompson318 commented 4 years ago

In GitLab by @ThomasDowrick on Feb 5, 2019, 08:49

At the moment, the requirements pages don't have anything useful on them:

https://scikit-surgeryvtk.readthedocs.io/en/latest/requirements.html
https://scikit-surgeryutils.readthedocs.io/en/latest/requirements.html

Should we be linking to this page instead? https://weisslab.cs.ucl.ac.uk/WEISS/PlatformManagement/SNAPPY/wikis/home

thompson318 commented 4 years ago

In GitLab by @StephenThompson on Feb 5, 2019, 09:30

PyCharm can go as far as I'm concerned. But requirements should stay in the template. If you don't want to use it for a particular project (eg surgeryvtk) then just delete it from that project. I used it (abit) for nditracker and will encourage its use it other projects.

thompson318 commented 4 years ago

In GitLab by @ThomasDowrick on Feb 5, 2019, 11:01

mentioned in merge request WEISS/SoftwareRepositories/PythonTemplate!19

thompson318 commented 4 years ago

In GitLab by @ThomasDowrick on Feb 5, 2019, 11:01

closed via commit WEISS/SoftwareRepositories/PythonTemplate@76986c51db8f24c4f19118bf6a7488df160dec94

thompson318 commented 4 years ago

In GitLab by @ThomasDowrick on Feb 5, 2019, 11:01

Ok, have removed the PyCharm page from PythonTemplate, will leave everything else as is and update individual repositores where needed.