SCIInstitute / UncertainSCI

MIT License
8 stars 10 forks source link

Initial drafts of model, parameters tutorials #70

Closed akilnarayan closed 3 years ago

akilnarayan commented 3 years ago

I'd like some feedback on how to solve some problems I've come up against in my initial sphinx tutorials. Mainly I want to look at stuff in docs/tutorials/models.md and docs/tutorials/parameters.md. The problem is that at present Sphinx does not render things as I'd like. Here are the current issues I have on my local machine:

akilnarayan commented 3 years ago

I fixed the inline equations issue. I still can't create tables, but I just avoided doing that for now. (Seems we're using Commonmark for the interpreter, but I couldn't find out how to create tables with Commonmark.)

I also still can't create citations, but there is just one hanging one for now, and that can probably be fixed later.

So for now I'll make this a genuine pull request for merging. Future pulls can probably iron out all these details.

jessdtate commented 3 years ago

I think I have tables working in the examples if you want to try to get it in this PR. https://uncertainsci--70.org.readthedocs.build/en/70/tutorials/template.html#tables