Commit d8d83a95 authored by Matthieu Muffato's avatar Matthieu Muffato
Browse files

Restructured the toc definitions to organize sections the exact way we want

parent ea1dc2db
.. Appendix
Scripts options quick reference
-------------------------------
......
Common dataflow_targets
=======================
Dataflow-target patterns
========================
Dataflow to an analysis
......
Common dataflows
================
Dataflow patterns
=================
Autoflow
......
......@@ -3,60 +3,85 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. Have a look at https://raw.githubusercontent.com/rtfd/readthedocs.org/master/docs/index.rst for inspiration
Welcome to the eHive user manual
================================
Contents:
eHive is great, and the user manual is great.
The code is open source, and `available on GitHub`_.
.. _available on GitHub: http://github.com/Ensembl/ensembl-hive
The main documentation for eHive is organized into a couple sections:
* :ref:`user-docs`
* :ref:`dev-docs`
.. _user-docs:
User documentation
==================
Quickstart
----------
.. toctree::
:numbered:
:glob:
:titlesonly:
:caption: Quickstart
quickstart/install
quickstart/quickstart
quickstart/*
Running pipelines
-----------------
.. toctree::
:numbered:
:glob:
:titlesonly:
:caption: Running pipelines
running_pipelines/*
running_pipelines/running
running_pipelines/monitoring
running_pipelines/management
Creating pipelines
==================
.. toctree::
:numbered:
:titlesonly:
:glob:
:caption: Creating pipelines
creating_pipelines/events
creating_pipelines/dataflows
creating_pipelines/dataflow_targets
creating_pipelines/pipeconfigs
creating_pipelines/scoping
creating_pipelines/semaphores
creating_pipelines/*
Creating runnables
==================
.. toctree::
:numbered:
:glob:
:titlesonly:
:caption: Creating runnables
creating_runnables/runnables
creating_runnables/*
Advanced usage
==============
.. toctree::
:maxdepth: 2
:glob:
:titlesonly:
:caption: Advanced usage
advanced_usage/mpi
advanced_usage/slack
advanced_usage/*
Appendix
========
.. toctree::
:titlesonly:
:caption: Appendix
:maxdepth: 1
:glob:
appendix/*
appendix/scripts
.. _dev-docs:
Developer documentation
=======================
TODO
Indices and tables
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment