Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document function registry, material properties, boundary condition enforcement #201

Open
jeff-cohere opened this issue Aug 13, 2021 · 1 comment
Assignees

Comments

@jeff-cohere
Copy link
Collaborator

I created a couple of stub pages in the Wiki where we can explain topics of interest that pertain to recent developments in TDycore. This issue can be closed when those pages are complete.

The Wiki remains our "short-term" documentation holding pen, I think, unless we prefer it to a more elaborate user guide underpinned by the Sphinx stuff. On the one hand, it's really easy to modify. On the other, it's very limited in terms of markup.

@jedbrown
Copy link
Member

At the conceptual level, I prefer keeping the docs in Sphinx because it's better for cross-referencing and more likely to be updated when something changes. A couple of my projects are/have moved to MyST (a markdown dialect with feature parity+ relative to ReST), and that reduces friction.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants