docs: adjust jobs documentation to rst + use extlinks extension

This commit is contained in:
Christian Schwarz
2017-11-10 12:48:41 +01:00
parent e0f40de69f
commit 6f7b8ca1af
7 changed files with 140 additions and 74 deletions

View File

@ -32,7 +32,8 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx.ext.todo',
'sphinx.ext.githubpages']
'sphinx.ext.githubpages',
'sphinx.ext.extlinks']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@ -155,4 +156,10 @@ texinfo_documents = [
]
# -- Options for the extlinks extension -----------------------------------
# http://www.sphinx-doc.org/en/stable/ext/extlinks.html
extlinks = {
'issue':('https://github.com/zrepl/zrepl/issues/%s', 'issue #'),
'sampleconf':('https://github.com/zrepl/zrepl/blob/master/cmd/sampleconf/%s', 'cmd/sampleconf')
}