Setup readthedocs.org documentation #148
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
A fair amount of content has been temporarily deleted. We will need to go back through the history to carry forward tbe parts that we want and re-implement them with these new templates. This includes: - Updates of some text - New autogen template to generate class definitions Still TODO: - Constructors - Special properties - Methods - Special sensor classes
ddemidov
force-pushed
the
rtfd
branch
3 times, most recently
from
e67c4d1 to
1c31cc9
Compare
|
Looks good to me; feel free to merge if you believe it's ready. Can you post a list of the information that isn't included yet? I can't quite tell from the diff. |
|
This has the same TODO list as the one in #146. All I did was convert to the new format. I'll merge this anyway, so that new work may be done in the new format. |
ddemidov
added a commit
that referenced
this pull request
Jan 17, 2016
Setup readthedocs.org documentation
|
OK, that's how it looked, I just wasn't sure. I'll update it when I can. |
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.
This was branched off version-updates so as not to loose any recent work by @WasabiFan. Hence the first three commits here.
This PR does a couple of things:
docsfolder with Sphinx configuration and a couple of reStructured text files. Some of them just import the original READMEs, some (actually, justclasses.rst) are generated fromspec.json, and others contain supporting hand-written text (mostly split out from the removedhuman-readable-spec.md).I've also created a project on readthedocs.org, and added the corresponding webhook to this repo. This way documentation on readthedocs.org will be autoupdated after each commit here. I have already added @rhempel as a maintainer of readthedocs project; @WasabiFan, if you tell me your username there, I'll add you as well.
The result looks like this: http://ev3dev-lang.readthedocs.org.
In order to generate the documentation locally, one needs to install Sphinx and Sphinx Bootstrap Theme, and then do
The html documentation will be created in the specified folder, which will be created if necessary.
Also see #146.