Update documentation - Githubissues

ewels / clusterflow

A pipelining tool to automate and standardise bioinformatics analyses on cluster environments.

https://ewels.github.io/clusterflow/

GNU General Public License v3.0

97 stars 27 forks source link

Update documentation #37

Closed ewels closed 8 years ago

ewels commented 9 years ago

When we go for the version release, update the documentation.

[x] Register http://www.clusterflow.io
[x] Set up hosting package for clusterflow.io
[x] Configure website
- [x] Use versioned docs - can have a development version to update as we develop
- [x] Get SSH access to server with git for deployment
- [x] Use symlinks and other stuff to make it all work
[x] Get v0.3 docs working on new setup
[x] Make homepage
[x] Write theme for v0.4
[x] Update changelog
[x] Update Python example module with new command line syntax
[x] Update module page documentation
[x] Go through docs and update
[x] Write quick start

ewels commented 9 years ago

Ditched Jekyll and wrote my own site engine using parsedown. Did some clever business with the .htaccess file and now have a docs directory with markdown files in the distro which is used directly to power the documentation website.

Some nice inspiration for docs website theming v0.4 on the stackedit website...

ewels commented 9 years ago

The so simple theme used by tophat / cufflinks etc now also has some nice features.

ewels commented 8 years ago

I just deleted the example Python module in 1db602102935662ae0af08ce4e0269102c6b09bd instead of updating it. I can't see that many people will want to write Python modules any time soon. Can always bring it back - see the (now deleted) preseq_plot module for a template.

ewels commented 8 years ago

Rewrote nearly all of the module documentation in 65af7788d024f0d071aad16a67d55b2920fb5ca5.

I think this is finally done!