Reorganize links

2024-12-18 20:37:55 +00:00 · 2018-07-08 18:22:43 +02:00 · 2018-07-08 18:22:43 +02:00 · 3655988315
commit 3655988315
parent b9c52925f9
18 changed files with 57 additions and 55 deletions
--- a/docs/_includes/all.rst
+++ 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
--- a/docs/_includes/html/defaults.rst
+++ b/docs/_includes/html/defaults.rst
@ -0,0 +1,3 @@
+.. |br| raw:: html
+
+   <br />
--- a/docs/_includes/images/external.rst
+++ b/docs/_includes/images/external.rst
--- a/docs/_includes/links/docker.rst
+++ b/docs/_includes/links/docker.rst
@ -1,6 +1,6 @@
 ..
   ============================================================
-   Docker
+   General Guides
   ============================================================

 .. |ext_lnk_install_docker| raw:: html
@ -139,33 +139,3 @@
   <a target="_blank" href="https://docs.docker.com/compose/env-file/">
     Declare default environment variables in file <img src="/_static/img/icons/ext-link.svg" />
   </a>
-
-
-..
-   ============================================================
-   Misc
-   ============================================================
-
-.. -------------------- uid --------------------
-
-.. |ext_lnk_uid| raw:: html
-
-   <a target="_blank" href="https://en.wikipedia.org/wiki/User_identifier">
-     Wikipedia: uid <img src="/_static/img/icons/ext-link.svg" />
-   </a>
-
-
-.. -------------------- ssh --------------------
-
-.. |ext_lnk_ssh_tunnelling_for_fun_and_profit| raw:: html
-
-   <a target="_blank" href="https://www.everythingcli.org/ssh-tunnelling-for-fun-and-profit-local-vs-remote/">
-     SSH tunnelling for fun and profie: Local vs Remote <img src="/_static/img/icons/ext-link.svg" />
-   </a>
-
-
-.. |ext_lnk_stackoverflow_ssh_into_docker_machine| raw:: html
-
-   <a target="_blank" href="https://stackoverflow.com/questions/30330442/how-to-ssh-into-docker-machine-virtualbox-instance">
-     Stackoverflow: SSH into Docker machine <img src="/_static/img/icons/ext-link.svg" />
-   </a>
--- a/docs/_includes/links/ssh.rst
+++ b/docs/_includes/links/ssh.rst
@ -0,0 +1,12 @@
+.. |ext_lnk_ssh_tunnelling_for_fun_and_profit| raw:: html
+
+   <a target="_blank" href="https://www.everythingcli.org/ssh-tunnelling-for-fun-and-profit-local-vs-remote/">
+     SSH tunnelling for fun and profie: Local vs Remote <img src="/_static/img/icons/ext-link.svg" />
+   </a>
+
+
+.. |ext_lnk_stackoverflow_ssh_into_docker_machine| raw:: html
+
+   <a target="_blank" href="https://stackoverflow.com/questions/30330442/how-to-ssh-into-docker-machine-virtualbox-instance">
+     Stackoverflow: SSH into Docker machine <img src="/_static/img/icons/ext-link.svg" />
+   </a>
--- a/docs/_includes/links/uid.rst
+++ b/docs/_includes/links/uid.rst
@ -0,0 +1,5 @@
+.. |ext_lnk_uid| raw:: html
+
+   <a target="_blank" href="https://en.wikipedia.org/wiki/User_identifier">
+     Wikipedia: uid <img src="/_static/img/icons/ext-link.svg" />
+   </a>
--- 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:

--- 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 <http://www.zytrax.com/books/dns/ch8/soa.html>`_
-
-
-
-
-
-
-.. |br| raw:: html
-
-   <br />
--- 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
--- 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:

--- 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:

--- 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:

--- 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:

 ***********************
--- 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:

 ********************************************
--- 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:

 ********************************************
--- 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:

--- 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:

--- a/docs/index.rst
+++ b/docs/index.rst
@ -1,6 +1,6 @@
 .. :hidden:

-.. include:: /_includes/global/images.rst
+.. include:: /_includes/all.rst

 **********************
 Devilbox documentation