search

graphnet-team / graphnet

A Deep learning library for neutrino telescopes
https://graphnet-team.github.io/graphnet/
Apache License 2.0
85 stars 85 forks source link

First Documentation Update #696

Closed RasmusOrsoe closed 2 months ago

RasmusOrsoe commented 2 months ago

This PR is the first in a series of updates to the documentation for graphnet hosted here. Closes #420 .

The main change in this PR is an installation matrix (see screenshot) that allows users to click their way to installation commands. To make it easier to review these changes, I've zipped the html files html.zip. When you unzip the folder and open the index.html, a local version of the documentation page should open.

image

To accommodate the different cuda versions, the torch_gpu.txt file under graphnet/requirement has been split into two, each representing a supported cuda version. The versions chosen here are from what is supported by PyG.

Minor changes:

The structure of the documentation is changed slightly under graphnet/docs. Instead of relying on one-off python scripts to convert static .md files into the .rst files (which is what sphinx requires), the files are now written in plain .rst. These conversion scripts have been deleted. The structure of the documentation is now:

   installation/install.rst #manual
   api/graphnet.rst #auto-generated
   about/about.rst #manual
   contribute/contribute.rst #manual

which we can expand upon in future pull requests.

RasmusOrsoe commented 2 months ago

Thank you very much for spotting those flaws! I have updated the language.