Turn the notes into a textbook (v2.0) #2
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@birocoles I want to start work on this and setup the infrastructure (TravisCI, sphinx configuration, etc). Then we can try to work slowly when we get a chance, instead of having to do a whole lot of work just to get started. |
It looks bad and was kind of huge.
|
Yeah I've seen it before. It looks promising but I've never used it before and I'm not sure what limitations it might have. It wouldn't be very nice to invest a lot of time on it and then come across something we can't do using it. Sphinx is more comfortable for me and it can generate all the formats that DocOnce can. Plus, I don't think you can run doctests from DocOnce but sphinx can. |
|
Have you tried it before? |
|
I have tried some simple examples. I have no problem in using Sphinx instead of DocOnce. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1
Make the lecture notes into a proper textbook (in English).
The goal is to have a practical introduction to the topic of inverse problems, with lots of examples and code.
Main features
Developing the 2.0 version
We'll use this PR and the
2.0branch as the basis for the new version. Only merge this PR when the 2.0 version is ready.Test versions and major changes that need to be discussed can be implemented in separate branches and merged into
2.0using a pull request.Use issues to discuss ideas and planning.