softengsquad / studentmap

0 stars 0 forks source link

[SOF-33] Generate documentation automatically #10

Closed lewisclark closed 5 months ago

lewisclark commented 5 months ago

Regenerates documentation and publishes to https://softengsquad.github.io/studentmap/ every time the master branch changes.

JohanKool3 commented 5 months ago

Generation is good but when trying to select different librarys, it reverts to a 404 not found error.

Error is with the spaces placed in the directory definition.

lewisclark commented 5 months ago

Generation is good but when trying to select different librarys, it reverts to a 404 not found error.

Error is with the spaces placed in the directory definition.

Documentation is being generated automatically. The formatting is a bit off but we can always reconfigure it later when we have more files to document (and more sub directories have been made in lib).

Perhaps we should adhere to https://dart.dev/effective-dart/style and/or add it into our styling specification document. It specifies that directory and file names must be lower-case and must contain underscores instead of spaces.