Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
Added documentation with Sphinx and reStructuredText #126
Thanks for setting this up Matthew. Based on what I have seen so far, the Sphinx documentation looks really good, format-wise.
Content-wise, I don't feel this version of the documentation is quite ready to replace the old one (even keeping in mind the various defects of the earlier version) because it seems to be missing an introductory section which explains at a high level what the software does. This was accomplished to some limited extent by the "About" section and "Understanding the RIVET visualization" section in the earlier version, but the content of these now appears further back in the documentation.
So I would suggest that we work on the content a little more to address this, before doing the merge. I can do some work on this in the next few days.
I agree with Mike's suggestions. We could make a page titled "About" or "Getting Started" with introductory content. We could also add some introductory text to the title page (the page that lists the contents).
Optionally, we could also flag key words in our documentation so that Sphinx will generate an index.
Lots of progress but still not near a local optimum. This currently won't compile. Created a Tikz figure showing the RIVET pipeline, including io capabilities.
TODO: -clean up "running RIVET" and input data to better fit with the new documentation. -Add a section output file formats. -Perhaps write a subsection explicitly on coarsening.
…zation in the subpage structure. Content still needs a lot of cleanup to fit this organization.
… progress and is currently a mess. Except for that, the draft of the new version of the documentation is pretty close to done.
…e content is still missing, however, especially about output formats. Need to converge on make sure names for the file types are consistent. (currently they are not.)