Separates docs for web and library

GSTT-CSC / hazen-web-app

Interactive web-based implementation of hazen

Other

0 stars 0 forks source link

Separates docs for web and library #25

Closed heyhaleema closed 2 years ago

heyhaleema commented 2 years ago

This PR:

Separates auto-generated docs for web and library, i.e. docs/source/web and docs/source/library, and manually-updated docs, i.e. docs/source
Updates theme options
Updates installation instructions based on README.md
Adds references, task descriptions and contributors (to be further refined)

tomaroberts commented 2 years ago

Thanks for this Haleema. I will have proper look through this, but from a quick glance I notice it edits some of the files in hazenlib – this folder is only temporarily going to be in the hazen-web-app repo whilst we do this early workup (see #20).

Guess we can commit those changes to this repo, but aware we will want to make the same changes to the hazen repo. This is more motivation for getting the hazen PyPI version online.

heyhaleema commented 2 years ago

Sounds good, I'll revert that specific commit from this branch and make the changes in the hazen repo, including the documentation setup.