openstack/deb-python-autobahn
Code Issues Proposed changes

doc cleanup

Browse Source
This commit is contained in:
Alexander Goedde
2014-08-10 12:08:10 +02:00
parent f9a2f9bc37
commit e6957e29d2
6 changed files with 16 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
doc/Makefile
View File

@@ -54,11 +54,17 @@ copy_serve:
cp serve.py ../../AutobahnCpp/doc/ cp serve.py ../../AutobahnCpp/doc/
cp serve.py ../../AutobahnTestsuite/doc/ cp serve.py ../../AutobahnTestsuite/doc/
copy_readme: copy_wordlist:
cp README.md ../../AutobahnJS/doc/ cp spelling_wordlist.txt ../../AutobahnJS/doc/
cp README.md ../../AutobahnAndroid/doc/ cp spelling_wordlist.txt ../../AutobahnAndroid/doc/
cp README.md ../../AutobahnCpp/doc/ cp spelling_wordlist.txt ../../AutobahnCpp/doc/
cp README.md ../../AutobahnTestsuite/doc/ cp spelling_wordlist.txt ../../AutobahnTestsuite/doc/
# copy_readme:
# cp README.md ../../AutobahnJS/doc/
# cp README.md ../../AutobahnAndroid/doc/
# cp README.md ../../AutobahnCpp/doc/
# cp README.md ../../AutobahnTestsuite/doc/
copy: copy_makefile copy_gitignore copy_serve copy: copy_makefile copy_gitignore copy_serve

2
doc/README.md
View File

@@ -1,6 +1,6 @@
# Documentation # Documentation
The documentation is generated using [Sphinx](http://sphinx.pocoo.org/) and the generated documentation is hosted [here](http://autobahn.ws/) under the language specific subsite. The documentation is generated using [Sphinx](http://sphinx.pocoo.org/) and the generated documentation is hosted [here](http://autobahn.ws/python).
## Prerequisites ## Prerequisites

1
doc/SConstruct
View File

@@ -42,6 +42,7 @@ BUCKET_PREFIX = 'python'
CSTATIC = "//tavendo-common-static.s3-eu-west-1.amazonaws.com" CSTATIC = "//tavendo-common-static.s3-eu-west-1.amazonaws.com"
CSTATIC_LOCAL = "http://127.0.0.1:8888" CSTATIC_LOCAL = "http://127.0.0.1:8888"
### END OF CONFIG ############################################################# ### END OF CONFIG #############################################################

6
doc/_templates/layout.html vendored
View File

@@ -11,11 +11,7 @@
.navbar-brand { .navbar-brand {
width: 239px; width: 239px;
height: 50px; height: 50px;
/*width: 209px;*/
/*height: 21px;*/
/*margin-top: 10px;*/
/*margin-left: 0px !important;*/
/*background-image: url({{ cstatic }}/img/gen/autobahnpython.svg.gz)*/
} }
.navbar-brand::after { .navbar-brand::after {

2
doc/_templates/side-primary.html vendored
View File

@@ -31,5 +31,3 @@
<h4><a href="{{ pathto('reference/autobahn') }}">API Reference</a></h4> <h4><a href="{{ pathto('reference/autobahn') }}">API Reference</a></h4>
<h4><a href="{{ pathto('genindex') }}">Index</a></h4> <h4><a href="{{ pathto('genindex') }}">Index</a></h4>
</div> </div>
<img src="" alt="">

6
doc/conf.py
View File

@@ -4,6 +4,7 @@ import os
import sys import sys
import sphinx_bootstrap_theme import sphinx_bootstrap_theme
# only needed for Autobahn|Python
sys.path.insert(0, os.path.abspath('./_extensions')) sys.path.insert(0, os.path.abspath('./_extensions'))
sys.path.insert(0, os.path.abspath('../autobahn')) sys.path.insert(0, os.path.abspath('../autobahn'))
@@ -14,7 +15,7 @@ extensions = [
'sphinx.ext.viewcode', 'sphinx.ext.viewcode',
'sphinx.ext.ifconfig', 'sphinx.ext.ifconfig',
'sphinxcontrib.spelling', 'sphinxcontrib.spelling',
'txsphinx' 'txsphinx' # only needed for Autobahn|Python
] ]
spelling_lang = 'en_US' spelling_lang = 'en_US'
@@ -194,9 +195,6 @@ html_logo = None
# Custom sidebar templates, maps document names to template names. # Custom sidebar templates, maps document names to template names.
html_sidebars = { html_sidebars = {
'index': [
'side-primary.html'
],
'**': [ '**': [
'side-primary.html' 'side-primary.html'
] ]