search

geodynamics / best_practices

Software development and training best practices.
13 stars 9 forks source link

Implement a .cls for Manual Template #11

Closed ljhwang closed 2 years ago

ljhwang commented 5 years ago

See discussion on pull request #10 .

Define macros and commands in a .cls, splitting it from the main.tex file.

baagaard-usgs commented 3 years ago

This issue will likely need updating after the developer workshop.

If there is a consensus to move to another format, e.g., Sphinx/RST, then we should put effort into a common theme/style for that.

jedbrown commented 3 years ago

I'd be in favor of Sphinx with MyST (https://myst-parser.readthedocs.io/), and probably using a variant of the pydata theme (CIG colors?).

ljhwang commented 3 years ago

SPECFEM and Rayleigh are already using readthedocs.io

jedbrown commented 3 years ago

ReadTheDocs works with Sphinx and MkDocs, but it's just a hosting service, and GitHub/GitLab Pages can also be used (without the ads that RTD inserts). Any Sphinx plugin (including MyST) can be used on RTD.

baagaard-usgs commented 2 years ago

Should we close this issue because we are moving to using Sphinx? Maybe open a new issue related to using a common theme for Sphinx?

gassmoeller commented 2 years ago

Yes, I think we can close this.