[joss review] how is the documentation built

SMTG-Bham / ThermoParser

A tool for streamlining data analysis and visualisation for thermoelectrics and charge carrier transport in computational materials science.

https://smtg-bham.github.io/ThermoParser/

GNU Affero General Public License v3.0

47 stars 15 forks source link

[joss review] how is the documentation built #84

Closed fnattino closed 8 months ago

fnattino commented 8 months ago

As far as I understand the docs are published on GitHub pages without using Jekyll (I also see the .nojekyll file), but there is a Jekyll config file in docs/_config.yml?

Also, why the folder docs/src/_build is checked in the repository? The build documentation is all available in docs , correct?

JOSS review issue

kbspooner commented 8 months ago

The docs folders were a mess! I've extended the changes mentioned in issue 85 to streamline the docs, and deleted some extra directories which must have been generated by me compiling them wrong and then never deleted.