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

Added links to doxygen for each Runnable (via doxylink)

This requires an extra python package
parent d9a38377
......@@ -38,11 +38,16 @@ extensions = [
'sphinx.ext.coverage',
'sphinx.ext.pngmath',
'sphinx.ext.graphviz',
'sphinxcontrib.doxylink',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
doxylink = {
'doxehive': (os.path.join(os.environ["EHIVE_ROOT_DIR"], "docs", "doxygen", "ensembl-hive.tag"), 'perl/'),
}
# Add markdown support
from recommonmark.parser import CommonMarkParser
......
......@@ -6,24 +6,15 @@ Several Runnables are included in the standard eHive distribution, serving as so
The included examples are:
- Bio::EnsEMBL::Hive::RunnableDB::DatabaseDumper
- :doxehive:`Bio::EnsEMBL::Hive::RunnableDB::DatabaseDumper`
- :doxehive:`Bio::EnsEMBL::Hive::RunnableDB::DbCmd`
- :doxehive:`Bio::EnsEMBL::Hive::RunnableDB::Dummy`
- :doxehive:`Bio::EnsEMBL::Hive::RunnableDB::FastaFactory`
- :doxehive:`Bio::EnsEMBL::Hive::RunnableDB::JobFactory`
- :doxehive:`Bio::EnsEMBL::Hive::RunnableDB::MySQLTransfer`
- :doxehive:`Bio::EnsEMBL::Hive::RunnableDB::NotifyByEmail`
- :doxehive:`Bio::EnsEMBL::Hive::RunnableDB::SlackNotification`
- :doxehive:`Bio::EnsEMBL::Hive::RunnableDB::SqlCmd`
- :doxehive:`Bio::EnsEMBL::Hive::RunnableDB::SqlHealthcheck`
- :doxehive:`Bio::EnsEMBL::Hive::RunnableDB::SystemCmd`
- Bio::EnsEMBL::Hive::RunnableDB::DbCmd
- Bio::EnsEMBL::Hive::RunnableDB::Dummy
- Bio::EnsEMBL::Hive::RunnableDB::FastaFactory
- Bio::EnsEMBL::Hive::RunnableDB::JobFactory
- Bio::EnsEMBL::Hive::RunnableDB::MySQLTransfer
- Bio::EnsEMBL::Hive::RunnableDB::NotifyByEmail
- Bio::EnsEMBL::Hive::RunnableDB::SlackNotification
- Bio::EnsEMBL::Hive::RunnableDB::SqlCmd
- Bio::EnsEMBL::Hive::RunnableDB::SqlHealthcheck
- Bio::EnsEMBL::Hive::RunnableDB::SystemCmd
......@@ -109,6 +109,7 @@ sub generate_docs_doxygen_perl {
my @cmds = (
"rm -rf $ehrd/docs/doxygen/perl",
"rm -f $ehrd/docs/doxygen/ensembl-hive.tag",
"doxygen -g -",
"echo 'PROJECT_NAME = ensembl-hive'",
"echo 'PROJECT_NUMBER = $code_ver'",
......@@ -128,6 +129,7 @@ sub generate_docs_doxygen_perl {
"echo 'HTML_DYNAMIC_SECTIONS = YES'",
"echo 'GENERATE_TREEVIEW = YES'",
"echo 'GENERATE_LATEX = NO'",
"echo 'GENERATE_TAGFILE = $ehrd/docs/doxygen/ensembl-hive.tag'",
"echo 'CLASS_DIAGRAMS = NO'",
"echo 'HAVE_DOT = YES'",
"echo 'COLLABORATION_GRAPH = NO'",
......
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