WIP: Sphinx document. #18
Open
Conversation
This file contains hidden or 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
This is at least somewhat comprehensible.
Labels need to be fixed.
make -f Makefile-sphinx latexpdf html
Contributor
Author
|
BTW, here is an example of the html doc http://rainwoodman.github.io/pfft/ |
Owner
|
Looks great. Thank you. I will have a deeper look at it as soon as Am 17.09.2015 um 02:08 schrieb Yu Feng:
Michael Pippig Phone: +49-371-531-37833 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 is a work in progress.
To build, install python, then
easy_install [--user] sphinx
make -f Makefile-sphinx html latexpdf
The document can be found at _build/html/ and _build/latex/
if ghp-import is installed,
ghp-import -n -p doc/_build/html/
will put document to mpip.github.io/pfft.
I also added a few scripts (convert.sh) to convert tex to rst files.
Major issues currently are missing cross-links between sections;
some lstinclude source files needs to be updated. And a few small issues with math.
How to best deal with these depends on if we want to abandon the tex files.