Move the User Manual out of the src/ directory

.bzrignore

@@ -3,9 +3,9 @@
 src/calibre/plugins
 resources/images.qrc
 src/calibre/ebooks/oeb/display/test/*.js
-src/calibre/manual/.build/
+manual/.build/
-src/calibre/manual/cli/
+manual/cli/
-src/calibre/manual/template_ref.rst
+manual/template_ref.rst
 build
 dist
 docs

manual/conf.py

@@ -14,7 +14,7 @@
 import sys, os
 
 # If your extensions are in another directory, add it here.
-sys.path.append(os.path.abspath('../../../'))
+sys.path.append(os.path.abspath('../src'))
 sys.path.append(os.path.abspath('.'))
 __appname__ = os.environ.get('__appname__', 'calibre')
 __version__ = os.environ.get('__version__', '0.0.0')
@@ -98,7 +98,7 @@ html_favicon = 'favicon.ico'
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the built-in static files,
 # so a file named "default.css" will overwrite the built-in "default.css".
-html_static_path = ['resources', '../../../icons/favicon.ico']
+html_static_path = ['resources', '../icons/favicon.ico']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.

manual/custom.py

@@ -5,9 +5,9 @@ __license__   = 'GPL v3'
 __copyright__ = '2008, Kovid Goyal <kovid at kovidgoyal.net>'
 import sys, os, re, textwrap
 
-sys.path.insert(0, os.path.abspath('../../'))
+sys.path.insert(0, os.path.abspath('../src'))
-sys.extensions_location = '../plugins'
+sys.extensions_location = '../src/calibre/plugins'
-sys.resources_location  = '../../../resources'
+sys.resources_location  = '../resources'
 
 from sphinx.util.console import bold
 

manual/customize.rst

@@ -39,7 +39,7 @@ Tweaks
 Tweaks are small changes that you can specify to control various aspects of |app|'s behavior. You can change them by going to Preferences->Advanced->Tweaks.
 The default values for the tweaks are reproduced below
 
-.. literalinclude:: ../../../resources/default_tweaks.py
+.. literalinclude:: ../resources/default_tweaks.py
 
 
 Overriding icons, templates, et cetera

manual/template_ref_generate.py

@@ -55,7 +55,7 @@ The python implementation of the template functions is passed in a Metadata obje
 
     The set of standard metadata fields.
 
-.. literalinclude:: ../ebooks/metadata/book/__init__.py
+.. literalinclude:: ../src/calibre/ebooks/metadata/book/__init__.py
    :lines: 7-
 '''
 

setup/installer/linux/freeze2.py

@@ -189,7 +189,7 @@ class LinuxFreeze(Command):
         for x in os.listdir(self.SRC):
             shutil.copytree(self.j(self.SRC, x), self.j(dest, x),
                     ignore=ignore_in_lib)
-        for x in ('manual', 'trac'):
+        for x in ('trac',):
             x = self.j(dest, 'calibre', x)
             if os.path.exists(x):
                 shutil.rmtree(x)

setup/publish.py

@@ -66,7 +66,7 @@ class Manual(Command):
 
     def run(self, opts):
         cwd = os.path.abspath(os.getcwd())
-        os.chdir(os.path.join(self.SRC, 'calibre', 'manual'))
+        os.chdir(os.path.join(self.SRC, '..', 'manual'))
         try:
             for d in ('.build', 'cli'):
                 if os.path.exists(d):

setup/upload.py

@@ -177,12 +177,12 @@ class UploadUserManual(Command): # {{{
             subprocess.check_call(['scp', f.name, 'divok:'+dest])
 
     def run(self, opts):
-        path = self.j(self.SRC, 'calibre', 'manual', 'plugin_examples')
+        path = self.j(self.SRC, '..', 'manual', 'plugin_examples')
         for x in glob.glob(self.j(path, '*')):
             self.build_plugin_example(x)
 
         check_call(' '.join(['rsync', '-z', '-r', '--progress',
-            'src/calibre/manual/.build/html/',
+            'manual/.build/html/',
                     'bugs:%s'%USER_MANUAL]), shell=True)
 # }}}