From 365598831508ab5c45191b5946721d5763a441c7 Mon Sep 17 00:00:00 2001 From: cytopia Date: Sun, 8 Jul 2018 18:22:43 +0200 Subject: [PATCH] Reorganize links --- docs/_includes/all.rst | 26 +++++++++++++++ docs/_includes/html/defaults.rst | 3 ++ .../images.rst => images/external.rst} | 0 .../{global/links.rst => links/docker.rst} | 32 +------------------ docs/_includes/links/ssh.rst | 12 +++++++ docs/_includes/links/uid.rst | 5 +++ docs/advanced/connect-to-host-os.rst | 2 +- docs/configuration-files/env-file.rst | 11 ++----- .../access-colleagues-devilbox.rst | 2 +- docs/getting-started/install-the-devilbox.rst | 2 +- docs/getting-started/prerequisites.rst | 3 +- .../docker-toolbox-and-the-devilbox.rst | 2 +- .../ssh-into-docker-toolbox.rst | 2 -- ...rt-forward-from-docker-toolbox-to-host.rst | 2 -- ...rt-forward-from-host-to-docker-toolbox.rst | 2 -- docs/howto/terminal/open-terminal-on-mac.rst | 2 +- docs/howto/terminal/open-terminal-on-win.rst | 2 +- docs/index.rst | 2 +- 18 files changed, 57 insertions(+), 55 deletions(-) create mode 100644 docs/_includes/all.rst create mode 100644 docs/_includes/html/defaults.rst rename docs/_includes/{global/images.rst => images/external.rst} (100%) rename docs/_includes/{global/links.rst => links/docker.rst} (83%) create mode 100644 docs/_includes/links/ssh.rst create mode 100644 docs/_includes/links/uid.rst diff --git a/docs/_includes/all.rst b/docs/_includes/all.rst new file mode 100644 index 00000000..763ca4d9 --- /dev/null +++ b/docs/_includes/all.rst @@ -0,0 +1,26 @@ +.. + ============================================================ + HTML + ============================================================ + +.. include:: /_includes/html/defaults.rst + + + +.. + ============================================================ + Images + ============================================================ + +.. include:: /_includes/images/external.rst + + + +.. + ============================================================ + Links + ============================================================ + +.. include:: /_includes/links/docker.rst +.. include:: /_includes/links/ssh.rst +.. include:: /_includes/links/uid.rst diff --git a/docs/_includes/html/defaults.rst b/docs/_includes/html/defaults.rst new file mode 100644 index 00000000..e4eba32f --- /dev/null +++ b/docs/_includes/html/defaults.rst @@ -0,0 +1,3 @@ +.. |br| raw:: html + +
diff --git a/docs/_includes/global/images.rst b/docs/_includes/images/external.rst similarity index 100% rename from docs/_includes/global/images.rst rename to docs/_includes/images/external.rst diff --git a/docs/_includes/global/links.rst b/docs/_includes/links/docker.rst similarity index 83% rename from docs/_includes/global/links.rst rename to docs/_includes/links/docker.rst index 66023262..defe4a73 100644 --- a/docs/_includes/global/links.rst +++ b/docs/_includes/links/docker.rst @@ -1,6 +1,6 @@ .. ============================================================ - Docker + General Guides ============================================================ .. |ext_lnk_install_docker| raw:: html @@ -139,33 +139,3 @@ Declare default environment variables in file - - -.. - ============================================================ - Misc - ============================================================ - -.. -------------------- uid -------------------- - -.. |ext_lnk_uid| raw:: html - - - Wikipedia: uid - - - -.. -------------------- ssh -------------------- - -.. |ext_lnk_ssh_tunnelling_for_fun_and_profit| raw:: html - - - SSH tunnelling for fun and profie: Local vs Remote - - - -.. |ext_lnk_stackoverflow_ssh_into_docker_machine| raw:: html - - - Stackoverflow: SSH into Docker machine - diff --git a/docs/_includes/links/ssh.rst b/docs/_includes/links/ssh.rst new file mode 100644 index 00000000..75e92c42 --- /dev/null +++ b/docs/_includes/links/ssh.rst @@ -0,0 +1,12 @@ +.. |ext_lnk_ssh_tunnelling_for_fun_and_profit| raw:: html + + + SSH tunnelling for fun and profie: Local vs Remote + + + +.. |ext_lnk_stackoverflow_ssh_into_docker_machine| raw:: html + + + Stackoverflow: SSH into Docker machine + diff --git a/docs/_includes/links/uid.rst b/docs/_includes/links/uid.rst new file mode 100644 index 00000000..e0cdbf62 --- /dev/null +++ b/docs/_includes/links/uid.rst @@ -0,0 +1,5 @@ +.. |ext_lnk_uid| raw:: html + + + Wikipedia: uid + diff --git a/docs/advanced/connect-to-host-os.rst b/docs/advanced/connect-to-host-os.rst index bc41f64c..1af96e95 100644 --- a/docs/advanced/connect-to-host-os.rst +++ b/docs/advanced/connect-to-host-os.rst @@ -1,4 +1,4 @@ -.. include:: /_includes/global/links.rst +.. include:: /_includes/all.rst .. _connect_to_host_os: diff --git a/docs/configuration-files/env-file.rst b/docs/configuration-files/env-file.rst index 256dfa18..be48758f 100644 --- a/docs/configuration-files/env-file.rst +++ b/docs/configuration-files/env-file.rst @@ -1,3 +1,5 @@ +.. include:: /_includes/all.rst + .. _env_file: ********* @@ -1602,12 +1604,3 @@ This variable controls the DNS Max Cache time in seconds. If empty or removed it +--------------------------+----------------------+---------------------+ .. seealso:: `BIND SOA `_ - - - - - - -.. |br| raw:: html - -
diff --git a/docs/corporate-usage/access-colleagues-devilbox.rst b/docs/corporate-usage/access-colleagues-devilbox.rst index 5c3f9209..6eb8187d 100644 --- a/docs/corporate-usage/access-colleagues-devilbox.rst +++ b/docs/corporate-usage/access-colleagues-devilbox.rst @@ -4,4 +4,4 @@ Access Colleague's Devilbox *************************** - +TODO diff --git a/docs/getting-started/install-the-devilbox.rst b/docs/getting-started/install-the-devilbox.rst index 22c90923..34c6bffc 100644 --- a/docs/getting-started/install-the-devilbox.rst +++ b/docs/getting-started/install-the-devilbox.rst @@ -1,4 +1,4 @@ -.. include:: /_includes/global/links.rst +.. include:: /_includes/all.rst .. _install_the_devilbox: diff --git a/docs/getting-started/prerequisites.rst b/docs/getting-started/prerequisites.rst index 65d9dc2e..39630c1e 100644 --- a/docs/getting-started/prerequisites.rst +++ b/docs/getting-started/prerequisites.rst @@ -1,5 +1,4 @@ -.. include:: /_includes/global/links.rst -.. include:: /_includes/global/images.rst +.. include:: /_includes/all.rst .. _prerequisites: diff --git a/docs/howto/docker-toolbox/docker-toolbox-and-the-devilbox.rst b/docs/howto/docker-toolbox/docker-toolbox-and-the-devilbox.rst index dda6735e..2d3336d4 100644 --- a/docs/howto/docker-toolbox/docker-toolbox-and-the-devilbox.rst +++ b/docs/howto/docker-toolbox/docker-toolbox-and-the-devilbox.rst @@ -1,6 +1,6 @@ :orphan: -.. include:: /_includes/global/links.rst +.. include:: /_includes/all.rst .. _howto_docker_toolbox_and_the_devilbox: diff --git a/docs/howto/docker-toolbox/ssh-into-docker-toolbox.rst b/docs/howto/docker-toolbox/ssh-into-docker-toolbox.rst index b60eea3a..ea503a97 100644 --- a/docs/howto/docker-toolbox/ssh-into-docker-toolbox.rst +++ b/docs/howto/docker-toolbox/ssh-into-docker-toolbox.rst @@ -1,7 +1,5 @@ :orphan: -.. include:: /_includes/global/links.rst - .. _howto_ssh_into_docker_toolbox: *********************** diff --git a/docs/howto/docker-toolbox/ssh-port-forward-from-docker-toolbox-to-host.rst b/docs/howto/docker-toolbox/ssh-port-forward-from-docker-toolbox-to-host.rst index 3eef5040..904c6440 100644 --- a/docs/howto/docker-toolbox/ssh-port-forward-from-docker-toolbox-to-host.rst +++ b/docs/howto/docker-toolbox/ssh-port-forward-from-docker-toolbox-to-host.rst @@ -1,7 +1,5 @@ :orphan: -.. include:: /_includes/global/links.rst - .. _howto_ssh_port_forward_from_docker_toolbox_to_host: ******************************************** diff --git a/docs/howto/docker-toolbox/ssh-port-forward-from-host-to-docker-toolbox.rst b/docs/howto/docker-toolbox/ssh-port-forward-from-host-to-docker-toolbox.rst index f45d8f02..db0cdbbb 100644 --- a/docs/howto/docker-toolbox/ssh-port-forward-from-host-to-docker-toolbox.rst +++ b/docs/howto/docker-toolbox/ssh-port-forward-from-host-to-docker-toolbox.rst @@ -1,7 +1,5 @@ :orphan: -.. include:: /_includes/global/links.rst - .. _howto_ssh_port_forward_from_host_to_docker_toolbox: ******************************************** diff --git a/docs/howto/terminal/open-terminal-on-mac.rst b/docs/howto/terminal/open-terminal-on-mac.rst index eebe2c7b..e1cb3770 100644 --- a/docs/howto/terminal/open-terminal-on-mac.rst +++ b/docs/howto/terminal/open-terminal-on-mac.rst @@ -1,6 +1,6 @@ :orphan: -.. include:: /_includes/global/links.rst +.. include:: /_includes/all.rst .. _howto_open_terminal_on_mac: diff --git a/docs/howto/terminal/open-terminal-on-win.rst b/docs/howto/terminal/open-terminal-on-win.rst index 817ace4e..ca46387f 100644 --- a/docs/howto/terminal/open-terminal-on-win.rst +++ b/docs/howto/terminal/open-terminal-on-win.rst @@ -1,6 +1,6 @@ :orphan: -.. include:: /_includes/global/links.rst +.. include:: /_includes/all.rst .. _howto_open_terminal_on_win: diff --git a/docs/index.rst b/docs/index.rst index 738938f6..ec3f0539 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,6 +1,6 @@ .. :hidden: -.. include:: /_includes/global/images.rst +.. include:: /_includes/all.rst ********************** Devilbox documentation