Convert documentation to Sphinx

CCSI-Toolset / MEA_ssm

MEA Steady State Model

https://mea-ssm.readthedocs.io/

Other

6 stars 7 forks source link

Convert documentation to Sphinx #21

Closed lbianchi-lbl closed 2 years ago

lbianchi-lbl commented 2 years ago

Incorporates changes from #19 and #20 (i.e. superseding them).

TODO

[x] Finish converting to semantic markup
- Using macros (e.g. |co2| instead of CO :sub: 2)
- Using :file: for file names/paths
- Using :guilabel: and :menuselection:
[x] See if it's possible to have numeric references with hyperlinks (the current 4-letter format is unusual)
[x] Review references, e.g. do they still point to the correct paper? (i.e. ensure that there wasn't any mistake in the conversion)

lbianchi-lbl commented 2 years ago

@jmorgan29 @ksbeattie This should be ready for review. Let me know if you spot anything off with the content or the formatting. To browse the rendered HTML without having to build the documentation locally, you can use the "Details" link displayed in the ReadTheDocs check: