search

macroevolution / bamm

A program for multimodel inference on speciation and trait evolution
GNU General Public License v2.0
33 stars 10 forks source link

sphinx documentation #35

Closed drabosky closed 10 years ago

drabosky commented 10 years ago

I'm just flagging this as an issue, but sphinx doc is not finished and this should stay open until it is done. Also, even when done, we will need to go through all the example code and make sure it can be run in R, since - unlike sweave - there is no guarantee that the example code is functional, which ccould be maddening to new users.

The installation, quickstart, configurations, FAQ and setting page are all pretty open for completion. i can work on theory section and bammtools (but would be good to see what others think about bammtools section). if you have some pretty cool figs we can think about putting them in the graph gallery as well.

redcurry commented 10 years ago

I'm happy to report that we now have an official website at www.bamm-project.org! I've uploaded the documentation from the latest repository. One thing I noticed is that we probably want a "face" for the website before people are shown the documentation. This first page should at least contain a brief summary of what bamm is, links to the documentation (what is currently shown), and the program to download for various operating systems.

redcurry commented 10 years ago

I have created a very basic welcome page (it's on the public website). Editing this page is a bit more complex because it's written in HTML (and some Jinja), but I think it's straightforward to follow. The page is located in doc/_templates/index.html. Since the welcome page is now index.html, I have renamed the old index.rst to documentation.rst.