From e87b44a703a64beaae56e005c96af2849224732d Mon Sep 17 00:00:00 2001 From: David Wilson Date: Sun, 14 Aug 2016 11:44:16 +0100 Subject: [PATCH] Hyperlinks. --- docs/_templates/github.html | 4 ++++ docs/conf.py | 2 +- docs/index.rst | 8 ++++++-- 3 files changed, 11 insertions(+), 3 deletions(-) create mode 100644 docs/_templates/github.html diff --git a/docs/_templates/github.html b/docs/_templates/github.html new file mode 100644 index 00000000..2735c31f --- /dev/null +++ b/docs/_templates/github.html @@ -0,0 +1,4 @@ +

+
+GitHub Repository +

diff --git a/docs/conf.py b/docs/conf.py index 37541150..05bacbde 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -7,7 +7,7 @@ exclude_patterns = ['_build'] extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx'] html_show_sourcelink = False html_show_sphinx = False -html_sidebars = {'**': ['globaltoc.html']} +html_sidebars = {'**': ['globaltoc.html', 'github.html']} html_static_path = ['_static'] html_theme = 'alabaster' htmlhelp_basename = 'econtextdoc' diff --git a/docs/index.rst b/docs/index.rst index b39348cd..95640453 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -28,10 +28,14 @@ damaged infrastructure, the remote machine need not even have a writeable filesystem. It is not intended as a generic RPC framework; the goal is to provide a robust -and efficient low-level API on which tools like **Salt** or **Ansible** can be -built, and while the API is quite friendly and similar in scope to **Fabric**, +and efficient low-level API on which tools like `Salt`_ or `Ansible`_ can be +built, and while the API is quite friendly and similar in scope to `Fabric`_, ultimately it should not be used directly by consumer software. +.. _Salt: https://docs.saltstack.com/en/latest/ +.. _Ansible: http://docs.ansible.com/ +.. _Fabric: http://docs.fabfile.org/en/ + The focus is to centralize and perfect the intricate dance required to run Python code safely and efficiently on a remote machine, while avoiding temporary files or large chunks of error-prone shell scripts.