ARTIST-Association/ARTIST

Documentation - Create static content

Closed this issue · 1 comments

Is your feature request related to a problem? Please describe.
Currently, the documentation is only generated with the Sphinx-auto-API, and there is no static content. Therefore, this content should be created.

Describe the solution you'd like
The static content should be added into the docs file and include:

  • A short description of ARTIST on the index.rst page.
  • Detailed installation instructions on the install.rst page.
  • A quickstart guide on the quickstart.rst page.

Update

I updated the index.rst page to conform with our README and started explaining the scenario HDF5 file structure. As soon as we have a minimal working example, I will start working on tutorials etc.