Skip to content

Commit

Permalink
Build toc and add download/install.
Browse files Browse the repository at this point in the history
  • Loading branch information
aplf committed Jul 4, 2016
1 parent f634106 commit b4deeec
Show file tree
Hide file tree
Showing 9 changed files with 90 additions and 16 deletions.
4 changes: 0 additions & 4 deletions docs/about.md

This file was deleted.

13 changes: 10 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@
# All configuration values have a default; values that are commented out
# serve to show the default.

import os
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
Expand All @@ -20,7 +23,9 @@
# import sys
# sys.path.insert(0, os.path.abspath('.'))

import sphinx_rtd_theme
if not on_rtd:
import sphinx_rtd_theme

from recommonmark.parser import CommonMarkParser

source_parsers = {
Expand Down Expand Up @@ -130,7 +135,8 @@
# a list of builtin themes.
#
#html_theme = 'alabaster'
html_theme = "sphinx_rtd_theme"
if not on_rtd:
html_theme = "sphinx_rtd_theme"

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand All @@ -140,7 +146,8 @@

# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
if not on_rtd:
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

# The name for this set of Sphinx documents.
# "<project> v<release> documentation" by default.
Expand Down
4 changes: 4 additions & 0 deletions docs/data_analysis.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Data analysis

TBD

4 changes: 4 additions & 0 deletions docs/display_and_visualization.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Display and visualization

TBD

53 changes: 53 additions & 0 deletions docs/dowload_and_install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Download and install

PHYLOViZ core and several plugins are free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

Certain source files distributed by the PHYLOViZ Team are under the terms of the GNU General Public License Version 3 with the following clarification and special exception, but only where PHYLOViZ Team has expressly included it in the particular source file's header.

```text
Linking this library statically or dynamically with other modules is
making a combined work based on this library. Thus, the terms and
conditions of the GNU General Public License cover the whole combination.
As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent modules,
and to copy and distribute the resulting executable under terms of your
choice, provided that you also meet, for each linked independent module,
the terms and conditions of the license of that module. An independent
module is a module which is not derived from or based on this library.
If you modify this library, you may extend this exception to your version
of the library, but you are not obligated to do so. If you do not wish
to do so, delete this exception statement from your version.
```

Code licensed under this license may be reused in commercial products provided that changes made directly in the sources - bug fixes or enhancements - must be contributed back to PHYLOViZ, but new source files (as in new plugins) which you write that link to PHYLOViZ code do not need to be.

Choose the appropriate version for your operating system or the .jar file. The OS specific versions already contain some memory specific parameters to enhance the software performance when using large datasets.

See details about available plugins and the licenses under which they are covered.

## Binaries

A cross-platform zip distribution package is [available](https://bitbucket.org/phyloviz/phyloviz-main/downloads).

Just unzip the package and run either bin/phyloviz.exe or bin/phyloviz accordingly to your operating system. Note that you must have a JRE environment installed. You may need to change some default parameters, such as memory requirements, in `etc/phyloviz.conf`.

*NOTE*: You may need to adjust some parameters in etc/phyloviz.conf with respect to memory usage. These settings have a strong impact on visualization features. For instance, in Windows, you may achieve better results with:

```text
default_options="--branding phyloviz -J-Xss8M -J-Xms32m -J-Xmx1024M --laf javax.swing.plaf.metal.MetalLookAndFeel"
```

*IMPORTANTE NOTICE*: After installing always go to the "Help" menu and "Check for updates" to install any novel plugins or latest updates to PHYLOViZ software. The SNP analysis plugin is installed in this way to demonstrate the plugin capability.

## Source

All the Source code is available in the new code repository for in bitbucket.org. Check it out at <https://bitbucket.org/phyloviz/phyloviz-main>.

PHYLOViZ is built on top of the NetBeans Platform, thus we recommend NetBeans for the development of new plugins.

16 changes: 7 additions & 9 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,16 @@
Welcome to PHYLOViZ's documentation!
====================================

Contents:
[PHYLOViZ](http://www.phyloviz.net) is a platform independent JAVA software that allows the analysis of sequence-based typing methods that generate allelic profiles and their associated epidemiological data.

.. toctree::
:maxdepth: 2

about
dowload_and_install
loading_data
data_analysis
display_and_visualization
querying_data
projects


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

4 changes: 4 additions & 0 deletions docs/loading_data.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Loading data

TBD

4 changes: 4 additions & 0 deletions docs/projects.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Project management

TBD

4 changes: 4 additions & 0 deletions docs/querying_data.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Querying data

TBD

0 comments on commit b4deeec

Please sign in to comment.