From f7110396a4733cb64f04d71b7e30a2b4b1813945 Mon Sep 17 00:00:00 2001 From: Alexander Goedde Date: Mon, 11 Aug 2014 18:36:45 +0200 Subject: [PATCH] doc fixes --- autobahnandroid.sublime.sublime-workspace | 336 +------------------- doc/_templates/layout.html | 6 +- doc/_templates/side-primary.html | 4 +- doc/{table_of_contents.rst => contents.rst} | 9 +- doc/index.rst | 5 +- 5 files changed, 24 insertions(+), 336 deletions(-) rename doc/{table_of_contents.rst => contents.rst} (55%) diff --git a/autobahnandroid.sublime.sublime-workspace b/autobahnandroid.sublime.sublime-workspace index 04d30fc1..52553e70 100644 --- a/autobahnandroid.sublime.sublime-workspace +++ b/autobahnandroid.sublime.sublime-workspace @@ -323,80 +323,6 @@ }, "buffers": [ - { - "file": "doc/README.md", - "settings": - { - "buffer_size": 1001, - "line_ending": "Windows" - } - }, - { - "file": "doc/SConstruct", - "settings": - { - "buffer_size": 2404, - "line_ending": "Windows" - } - }, - { - "file": "/C/Users/AG/scm/Autobahn/AutobahnPython/doc/conf.py", - "settings": - { - "buffer_size": 14083, - "line_ending": "Windows" - } - }, - { - "file": "doc/_templates/layout.html", - "settings": - { - "buffer_size": 2691, - "line_ending": "Windows" - } - }, - { - "file": "doc/examples.rst", - "settings": - { - "buffer_size": 1308, - "line_ending": "Windows" - } - }, - { - "contents": "Searching 912 files for \"*.txt\"\n\n0 matches across 0 files\n", - "settings": - { - "buffer_size": 58, - "line_ending": "Windows", - "name": "Find Results", - "scratch": true - } - }, - { - "file": "/C/Users/AG/scm/Autobahn/AutobahnPython/doc/SConstruct", - "settings": - { - "buffer_size": 2402, - "line_ending": "Windows" - } - }, - { - "file": "doc/_templates/side-primary.html", - "settings": - { - "buffer_size": 1272, - "line_ending": "Windows" - } - }, - { - "file": "doc/conf.py", - "settings": - { - "buffer_size": 13619, - "line_ending": "Windows" - } - } ], "build_system": "Packages/JSHint/JSHint.sublime-build", "command_palette": @@ -430,16 +356,20 @@ }, "file_history": [ + "/C/Users/AG/scm/Autobahn/AutobahnPython/doc/conf.py", + "/C/Users/AG/scm/Autobahn/AutobahnAndroid/doc/SConstruct", + "/C/Users/AG/scm/Autobahn/AutobahnAndroid/doc/conf.py", + "/C/Users/AG/scm/Autobahn/AutobahnAndroid/doc/_templates/side-primary.html", + "/C/Users/AG/scm/Autobahn/AutobahnPython/doc/SConstruct", + "/C/Users/AG/scm/Autobahn/AutobahnAndroid/doc/examples.rst", + "/C/Users/AG/scm/Autobahn/AutobahnAndroid/doc/_templates/layout.html", + "/C/Users/AG/scm/Autobahn/AutobahnAndroid/doc/README.md", "/C/Users/AG/scm/Autobahn/AutobahnAndroid/doc/_build/html/_sources/gettingstarted.txt", "/C/Users/AG/scm/Autobahn/AutobahnAndroid/doc/gettingstarted.rst", "/C/Users/AG/scm/Autobahn/AutobahnAndroid/doc/_static/local.css", - "/C/Users/AG/scm/Autobahn/AutobahnAndroid/doc/examples.rst", "/C/Users/AG/scm/Autobahn/AutobahnAndroid/doc/index.rst", "/C/Users/AG/scm/Autobahn/AutobahnAndroid/doc/_static/page.css", - "/C/Users/AG/scm/Autobahn/AutobahnAndroid/doc/conf.py", - "/C/Users/AG/scm/Autobahn/AutobahnAndroid/doc/_templates/side-primary.html", "/C/Users/AG/scm/Autobahn/AutobahnJS/doc/conf.py", - "/C/Users/AG/scm/Autobahn/AutobahnAndroid/doc/_templates/layout.html", "/C/Users/AG/scm/Autobahn/AutobahnAndroid/doc/_static/communitywidget.css", "/C/Users/AG/scm/Autobahn/AutobahnAndroid/README.md", "/C/Users/AG/scm/Autobahn/AutobahnAndroid/doc/_templates/side-secondary.html", @@ -453,7 +383,6 @@ "/C/Users/AG/scm/Autobahn/AutobahnJS/doc/index.rst", "/C/Users/AG/scm/Autobahn/AutobahnAndroid/doc/_gen/de/tavendo/autobahn/PrefixMap.rst", "/C/Users/AG/scm/Autobahn/AutobahnAndroid/doc/Makefile", - "/C/Users/AG/scm/Autobahn/AutobahnAndroid/doc/README.md", "/C/Users/AG/scm/Autobahn/AutobahnPython/doc/README.md", "/C/Users/AG/scm/Autobahn/AutobahnPython/doc/index.rst", "/C/Users/AG/scm/Autobahn/AutobahnPython/examples/twisted/wamp/basic/pubsub/basic/backend.html", @@ -554,10 +483,7 @@ "/C/Users/AG/scm/WebMQControlCenter/MANIFEST.in", "/C/Users/AG/scm/WebMQControlCenter/Makefile", "/C/Users/AG/scm/WebMQManual/manual/administration/system/update.rst", - "/C/Users/AG/scm/WebMQManual/manual/gettingstarted/index.rst", - "/C/Users/AG/scm/WebMQManual/manual/administration/system/keys.rst", - "/C/Users/AG/scm/WebMQManual/manual/administration/system/network.rst", - "/C/Users/AG/scm/WebMQManual/manual/administration/system/overview.rst" + "/C/Users/AG/scm/WebMQManual/manual/gettingstarted/index.rst" ], "find": { @@ -565,7 +491,7 @@ }, "find_in_files": { - "height": 90.0, + "height": 0.0, "where_history": [ "C:\\Users\\AG\\scm\\Autobahn\\AutobahnAndroid\\doc", @@ -665,255 +591,13 @@ "groups": [ { - "selected": 2, "sheets": [ - { - "buffer": 0, - "file": "doc/README.md", - "settings": - { - "buffer_size": 1001, - "regions": - { - }, - "selection": - [ - [ - 0, - 0 - ] - ], - "settings": - { - "syntax": "Packages/Markdown/Markdown.tmLanguage" - }, - "translation.x": 0.0, - "translation.y": 0.0, - "zoom_level": 1.0 - }, - "type": "text" - }, - { - "buffer": 1, - "file": "doc/SConstruct", - "settings": - { - "buffer_size": 2404, - "regions": - { - }, - "selection": - [ - [ - 0, - 0 - ] - ], - "settings": - { - "syntax": "Packages/Python/Python.tmLanguage" - }, - "translation.x": 0.0, - "translation.y": 0.0, - "zoom_level": 1.0 - }, - "type": "text" - }, - { - "buffer": 2, - "file": "/C/Users/AG/scm/Autobahn/AutobahnPython/doc/conf.py", - "settings": - { - "buffer_size": 14083, - "regions": - { - }, - "selection": - [ - [ - 1545, - 1545 - ] - ], - "settings": - { - "syntax": "Packages/Python/Python.tmLanguage" - }, - "translation.x": 0.0, - "translation.y": 1710.0, - "zoom_level": 1.0 - }, - "type": "text" - } ] }, { - "selected": 5, "sheets": [ - { - "buffer": 3, - "file": "doc/_templates/layout.html", - "settings": - { - "buffer_size": 2691, - "regions": - { - }, - "selection": - [ - [ - 748, - 748 - ] - ], - "settings": - { - "syntax": "Packages/HTML/HTML.tmLanguage" - }, - "translation.x": 0.0, - "translation.y": 0.0, - "zoom_level": 1.0 - }, - "type": "text" - }, - { - "buffer": 4, - "file": "doc/examples.rst", - "settings": - { - "buffer_size": 1308, - "regions": - { - }, - "selection": - [ - [ - 0, - 0 - ] - ], - "settings": - { - "syntax": "Packages/RestructuredText/reStructuredText.tmLanguage" - }, - "translation.x": 0.0, - "translation.y": 0.0, - "zoom_level": 1.0 - }, - "type": "text" - }, - { - "buffer": 5, - "settings": - { - "buffer_size": 58, - "regions": - { - }, - "selection": - [ - [ - 0, - 0 - ] - ], - "settings": - { - "detect_indentation": false, - "output_tag": 1, - "result_base_dir": "", - "result_file_regex": "^([A-Za-z\\\\/<].*):$", - "result_line_regex": "^ +([0-9]+):", - "scroll_past_end": true, - "syntax": "Packages/Default/Find Results.hidden-tmLanguage", - "translate_tabs_to_spaces": false - }, - "translation.x": 0.0, - "translation.y": 0.0, - "zoom_level": 1.0 - }, - "type": "text" - }, - { - "buffer": 6, - "file": "/C/Users/AG/scm/Autobahn/AutobahnPython/doc/SConstruct", - "settings": - { - "buffer_size": 2402, - "regions": - { - }, - "selection": - [ - [ - 2141, - 2141 - ] - ], - "settings": - { - "syntax": "Packages/Python/Python.tmLanguage" - }, - "translation.x": 0.0, - "translation.y": 540.0, - "zoom_level": 1.0 - }, - "type": "text" - }, - { - "buffer": 7, - "file": "doc/_templates/side-primary.html", - "settings": - { - "buffer_size": 1272, - "regions": - { - }, - "selection": - [ - [ - 130, - 130 - ] - ], - "settings": - { - "syntax": "Packages/HTML/HTML.tmLanguage" - }, - "translation.x": 0.0, - "translation.y": 0.0, - "zoom_level": 1.0 - }, - "type": "text" - }, - { - "buffer": 8, - "file": "doc/conf.py", - "settings": - { - "buffer_size": 13619, - "regions": - { - }, - "selection": - [ - [ - 4550, - 4550 - ] - ], - "settings": - { - "syntax": "Packages/Python/Python.tmLanguage" - }, - "translation.x": 0.0, - "translation.y": 1530.0, - "zoom_level": 1.0 - }, - "type": "text" - } ] } ], diff --git a/doc/_templates/layout.html b/doc/_templates/layout.html index 7425949c..9bc36e13 100644 --- a/doc/_templates/layout.html +++ b/doc/_templates/layout.html @@ -24,12 +24,14 @@ content: url({{ cstatic }}/img/gen/autobahnandroid.svg.gz); } + /* not formatted as a Sphinx note since this doesn't allow multi-paragraph notes */ .legacynotice { padding: 1em; - background-color: #FFBF5D; - border: 1px solid #D48205; margin: 1em; max-width: 700px; + border-radius: 12px; + border-left: 12px solid red; + box-shadow: 0 0 8px 1px rgba(0, 0, 0, 0.2); } diff --git a/doc/_templates/side-primary.html b/doc/_templates/side-primary.html index a7106ad8..bc9743d6 100644 --- a/doc/_templates/side-primary.html +++ b/doc/_templates/side-primary.html @@ -23,12 +23,12 @@

Sta
-

{{ _('Site Contents') }}

+

{{ _('Site Contents') }}

Page Contents

{{ toc }}
-

API Reference

+

API Reference

Index

diff --git a/doc/table_of_contents.rst b/doc/contents.rst similarity index 55% rename from doc/table_of_contents.rst rename to doc/contents.rst index ed11fc7d..e398eb6b 100644 --- a/doc/table_of_contents.rst +++ b/doc/contents.rst @@ -1,7 +1,10 @@ -.. _table_of_contents: +:tocdepth: 0 +:orphan: -Table of Contents -================= +.. _site_contents: + +Site Contents +============= .. toctree:: :maxdepth: 3 diff --git a/doc/index.rst b/doc/index.rst index 3c5f0f0b..3c05dc63 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,8 +1,8 @@ .. -|ab| Documentation -================== +|ab| +==== .. container:: legacynotice @@ -183,7 +183,6 @@ If you like, :doc:`get started `, check out the :doc:`examples` gettingstarted examples _gen/packages - table_of_contents Indices and tables