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

Refactor repository into Sphinx documentation (docs) and potentially example code (src) #36

Open
baagaard-usgs opened this issue Mar 29, 2024 · 1 comment

Comments

@baagaard-usgs
Copy link
Contributor

baagaard-usgs commented Mar 29, 2024

Currently, the repository is a collection of Markdown examples. It would be nice to move the Markdown files into Sphinx style documentation to facilitate searching and navigating.

Would make it easier to embed examples, etc in text boxes, etc.

@gassmoeller
Copy link
Member

@ljhwang and I talked about this again. Lorraine found a way to include drop-down descriptions into markdown files (see https://github.com/geodynamics/best_practices/blob/main/SoftwareDevelopmentBestPractices.md), and that may be a better way than setting up a whole Sphinx infrastructure just to be able to add examples. We can keep this open for discussion, but at least for the current update to the best practices we would leave out the sphinx infrastructure.

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