From dc2e9e2dd18657256cfb419c8f320fdb8d12697d Mon Sep 17 00:00:00 2001 From: David Wilson Date: Mon, 1 Apr 2019 03:01:02 +0100 Subject: [PATCH] import redirector --- docs/.gitignore | 1 + docs/Makefile | 2 ++ docs/_templates/_redirect.html | 23 ++++++++++++++++++++++ docs/_templates/ansible.html | 3 +++ docs/_templates/ansible_detailed.html | 3 +++ docs/_templates/api.html | 3 +++ docs/_templates/changelog.html | 3 +++ docs/_templates/contributors.html | 3 +++ docs/_templates/examples.html | 3 +++ docs/_templates/getting_started.html | 3 +++ docs/_templates/howitworks.html | 3 +++ docs/_templates/index.html | 3 +++ docs/_templates/internals.html | 3 +++ docs/_templates/layout.html | 3 +++ docs/_templates/piwik-config.js | 5 +++++ docs/_templates/services.html | 3 +++ docs/_templates/signals.html | 3 +++ docs/_templates/toc.html | 3 +++ docs/conf.py | 28 +++++++++++++++++++++++++++ docs/placeholder.rst | 3 +++ docs/requirements.txt | 1 + 21 files changed, 105 insertions(+) create mode 100644 docs/.gitignore create mode 100644 docs/Makefile create mode 100644 docs/_templates/_redirect.html create mode 100644 docs/_templates/ansible.html create mode 100644 docs/_templates/ansible_detailed.html create mode 100644 docs/_templates/api.html create mode 100644 docs/_templates/changelog.html create mode 100644 docs/_templates/contributors.html create mode 100644 docs/_templates/examples.html create mode 100644 docs/_templates/getting_started.html create mode 100644 docs/_templates/howitworks.html create mode 100644 docs/_templates/index.html create mode 100644 docs/_templates/internals.html create mode 100644 docs/_templates/layout.html create mode 100644 docs/_templates/piwik-config.js create mode 100644 docs/_templates/services.html create mode 100644 docs/_templates/signals.html create mode 100644 docs/_templates/toc.html create mode 100644 docs/conf.py create mode 100644 docs/placeholder.rst create mode 100644 docs/requirements.txt diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 00000000..378eac25 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +build diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 00000000..33da6c0a --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,2 @@ +default: + sphinx-build . build/html/ diff --git a/docs/_templates/_redirect.html b/docs/_templates/_redirect.html new file mode 100644 index 00000000..1957ebb8 --- /dev/null +++ b/docs/_templates/_redirect.html @@ -0,0 +1,23 @@ + +{{title}} (Redirect) + + + + diff --git a/docs/_templates/ansible.html b/docs/_templates/ansible.html new file mode 100644 index 00000000..71d5fadb --- /dev/null +++ b/docs/_templates/ansible.html @@ -0,0 +1,3 @@ +{%- with title="Mitogen for Ansible", url='https://networkgenomics.com/ansible/' -%} + {%- include "_redirect.html" -%} +{%- endwith -%} diff --git a/docs/_templates/ansible_detailed.html b/docs/_templates/ansible_detailed.html new file mode 100644 index 00000000..62b7f4ef --- /dev/null +++ b/docs/_templates/ansible_detailed.html @@ -0,0 +1,3 @@ +{%- with title="Mitogen for Ansible", url='https://mitogen.networkgenomics.com/ansible_detailed.html' -%} + {%- include "_redirect.html" -%} +{%- endwith -%} diff --git a/docs/_templates/api.html b/docs/_templates/api.html new file mode 100644 index 00000000..3022d48a --- /dev/null +++ b/docs/_templates/api.html @@ -0,0 +1,3 @@ +{%- with title="API Reference", url='https://mitogen.networkgenomics.com/api.html' -%} + {%- include "_redirect.html" -%} +{%- endwith -%} diff --git a/docs/_templates/changelog.html b/docs/_templates/changelog.html new file mode 100644 index 00000000..d89fb4c5 --- /dev/null +++ b/docs/_templates/changelog.html @@ -0,0 +1,3 @@ +{%- with title="Release Notes", url='https://mitogen.networkgenomics.com/changelog.html' -%} + {%- include "_redirect.html" -%} +{%- endwith -%} diff --git a/docs/_templates/contributors.html b/docs/_templates/contributors.html new file mode 100644 index 00000000..148b3e78 --- /dev/null +++ b/docs/_templates/contributors.html @@ -0,0 +1,3 @@ +{%- with title="Contributors", url='https://mitogen.networkgenomics.com/contributors.html' -%} + {%- include "_redirect.html" -%} +{%- endwith -%} diff --git a/docs/_templates/examples.html b/docs/_templates/examples.html new file mode 100644 index 00000000..2bb55662 --- /dev/null +++ b/docs/_templates/examples.html @@ -0,0 +1,3 @@ +{%- with title="Examples", url='https://mitogen.networkgenomics.com/examples.html' -%} + {%- include "_redirect.html" -%} +{%- endwith -%} diff --git a/docs/_templates/getting_started.html b/docs/_templates/getting_started.html new file mode 100644 index 00000000..a82ec96e --- /dev/null +++ b/docs/_templates/getting_started.html @@ -0,0 +1,3 @@ +{%- with title="Getting Started", url='https://mitogen.networkgenomics.com/getting_started.html' -%} + {%- include "_redirect.html" -%} +{%- endwith -%} diff --git a/docs/_templates/howitworks.html b/docs/_templates/howitworks.html new file mode 100644 index 00000000..e58d1cbf --- /dev/null +++ b/docs/_templates/howitworks.html @@ -0,0 +1,3 @@ +{%- with title="How Mitogen Works", url='https://mitogen.networkgenomics.com/howitworks.html' -%} + {%- include "_redirect.html" -%} +{%- endwith -%} diff --git a/docs/_templates/index.html b/docs/_templates/index.html new file mode 100644 index 00000000..89da8a95 --- /dev/null +++ b/docs/_templates/index.html @@ -0,0 +1,3 @@ +{%- with title="Mitogen", url='https://mitogen.networkgenomics.com/' -%} + {%- include "_redirect.html" -%} +{%- endwith -%} diff --git a/docs/_templates/internals.html b/docs/_templates/internals.html new file mode 100644 index 00000000..952c53cc --- /dev/null +++ b/docs/_templates/internals.html @@ -0,0 +1,3 @@ +{%- with title="Internal API Reference", url='https://mitogen.networkgenomics.com/internals.html' -%} + {%- include "_redirect.html" -%} +{%- endwith -%} diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html new file mode 100644 index 00000000..790b07c9 --- /dev/null +++ b/docs/_templates/layout.html @@ -0,0 +1,3 @@ + + + diff --git a/docs/_templates/piwik-config.js b/docs/_templates/piwik-config.js new file mode 100644 index 00000000..ad24c9f6 --- /dev/null +++ b/docs/_templates/piwik-config.js @@ -0,0 +1,5 @@ +window._paq = []; +window._paq.push(['trackPageView']); +window._paq.push(['enableLinkTracking']); +window._paq.push(['enableHeartBeatTimer', 30]); +window._paq.push(['setSiteId', 6]); diff --git a/docs/_templates/services.html b/docs/_templates/services.html new file mode 100644 index 00000000..739b589b --- /dev/null +++ b/docs/_templates/services.html @@ -0,0 +1,3 @@ +{%- with title="Service Framework", url='https://mitogen.networkgenomics.com/services.html' -%} + {%- include "_redirect.html" -%} +{%- endwith -%} diff --git a/docs/_templates/signals.html b/docs/_templates/signals.html new file mode 100644 index 00000000..3535b368 --- /dev/null +++ b/docs/_templates/signals.html @@ -0,0 +1,3 @@ +{%- with title="Signals", url='https://mitogen.networkgenomics.com/ansible_detailed.html' -%} + {%- include "_redirect.html" -%} +{%- endwith -%} diff --git a/docs/_templates/toc.html b/docs/_templates/toc.html new file mode 100644 index 00000000..3ca58279 --- /dev/null +++ b/docs/_templates/toc.html @@ -0,0 +1,3 @@ +{%- with title="Table Of Contents", url='https://mitogen.networkgenomics.com/toc.html' -%} + {%- include "_redirect.html" -%} +{%- endwith -%} diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..0cd696ec --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,28 @@ +author = u'David Wilson' +copyright = u'2019, David Wilson' +exclude_patterns = ['_build'] +html_additional_pages = { + 'ansible': 'ansible.html', + 'ansible_detailed': 'ansible_detailed.html', + 'api': 'api.html', + 'changelog': 'changelog.html', + 'contributors': 'contributors.html', + 'examples': 'examples.html', + 'getting_started': 'getting_started.html', + 'howitworks': 'howitworks.html', + 'index': 'index.html', + 'internals': 'internals.html', + 'services': 'services.html', + 'signals': 'signals.html', + 'toc': 'toc.html', +} + +html_theme = 'basic' +language = None +master_doc = 'placeholder' +project = u'Mitogen' +pygments_style = 'sphinx' +release = '0.0' +source_suffix = '.rst' +templates_path = ['_templates'] +version = '0.0' diff --git a/docs/placeholder.rst b/docs/placeholder.rst new file mode 100644 index 00000000..3f3809fd --- /dev/null +++ b/docs/placeholder.rst @@ -0,0 +1,3 @@ + +Placeholder +=========== diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..233ebaa2 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1 @@ +Sphinx==1.7.1