Add base documentation #91
Merged
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
|
Part of this PR should be adding sphinx docs to each of the user facing commands on the |
danlamanna
force-pushed
the
formal-documentation
branch
2 times, most recently
from
464121c to
b9ff0b3
Compare
Namely, it would require building GDAL within RTD or doing a large amount of mocking.
danlamanna
force-pushed
the
formal-documentation
branch
from
b9ff0b3 to
eaeadd4
Compare
|
@jbeezley PTAL Note once this is merged, @dorukozturk can delete the S3 bucket we were previously relying on for geotiffs. |
jbeezley
approved these changes
Mar 30, 2017
aashish24
reviewed
Mar 30, 2017
docs/source/developer-docs.rst
Outdated
| When you execute python in a Jupyter Notebook cell the python code was transmitted (as a string) over a web socket to the webserver, then proxied through ZeroMQ to the IPykernel where it was evaluated as a Python expression. The results of that execution are then sent back over the ZeroMQ/Websocket connection and displayed in your browser. This is the standard way in which Jupyter notebook takes code from a web browser, and executes it in an interactive shell (kernel) and returns the output. | ||
|
|
||
|
|
||
| *TODO introduce comm channels* |
There was a problem hiding this comment.
@danlamanna are we planning to keep TODO's?
There was a problem hiding this comment.
We can, or we can put them inside an issue with a checklist. It's up to us.
There was a problem hiding this comment.
My slight preference to put them inside an issue with a checklist if it is not too much work but I am okay with this as it is (if you want to go ahead and merge it).
|
related: #111 |
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.
Addresses #35 and #77
Nothing to review here yet @kotfic, but we can use this PR as a means of discussing a TOC and collaborating on docs.
I'm thinking a baseline TOC could look something like this: