incorporate personal site templates into a build that lets me generate hosted docs

--HG--
rename : docsource/conf.py => sphinx/pkg/conf.py

Author: dhellmann

.hgignore

@@ -6,6 +6,8 @@ setup.py
 trace.txt
 docs
 *.pyc
+sphinx/web/templates/base.html
 
 syntax: re
 .DS_Store
+^web/

docsource/Makefile

@@ -20,6 +20,7 @@
 import paver.setuputils
 paver.setuputils.install_distutils_tasks()
 import paver.doctools
+import docpaver
 
 # What project are we building?
 PROJECT = 'virtualenvwrapper'
@@ -49,7 +50,7 @@
         author = 'Doug Hellmann',
         author_email = 'doug.hellmann@gmail.com',
 
-        url = 'http://www.doughellmann.com/projects/virtualenvwrapper/',
+        url = 'http://www.doughellmann.com/projects/%s/' % PROJECT,
         download_url = 'http://www.doughellmann.com/downloads/%s-%s.tar.gz' % \
                         (PROJECT, VERSION),
 
@@ -78,8 +79,29 @@
 
     sphinx = Bunch(
         docroot='.',
-        builddir='docs',
         sourcedir='docsource',
+        builder='html',
+        template_args={'project':PROJECT}
+    ),
+    
+    html=Bunch(
+        templates='pkg',
+        builddir='docs',
+        confdir='sphinx/pkg',
+    ),
+    
+    website=Bunch(
+        templates = 'web',
+        builddir = 'web',
+        confdir='sphinx/web',
+        
+        # What server hosts the website?
+        server = 'www.doughellmann.com',
+        server_path = '/var/www/doughellmann/DocumentRoot/docs/%s/' % PROJECT,
+
+        # What template should be used for the web site HTML?
+        template_source = '~/Devel/personal/doughellmann/templates/base.html',
+        template_dest = 'sphinx/web/templates/base.html',        
     ),
 
     sdist = Bunch(
@@ -94,6 +116,31 @@
 
 )
 
+@task
+def html(options):
+    # Build the docs
+    docpaver.html(options)
+    # Move them into place for packaging
+    destdir = path(PROJECT) / 'docs'
+    destdir.rmtree()
+    builtdocs = path(options.builddir) / "html"
+    builtdocs.move(destdir)
+    return
+
+@task
+def website(options):
+    """Create local copy of website files.
+    """
+    # Make sure the base template is updated
+    dest = path(options.website.template_dest).expanduser()
+    src = path(options.website.template_source).expanduser()
+    if not dest.exists() or (src.mtime > dest.mtime):
+        dest.dirname().mkdir()
+        src.copy(dest)
+    # Build the docs
+    docpaver.run_sphinx(options, 'website')
+    return
+
 def remake_directories(*dirnames):
     """Remove the directories and recreate them.
     """
@@ -105,14 +152,21 @@ def remake_directories(*dirnames):
     return
 
 @task
-@needs('paver.doctools.html')
-def html(options):
-    destdir = path(PROJECT) / 'docs'
-    destdir.rmtree()
-    builtdocs = path(options.builddir) / "html"
-    builtdocs.move(destdir)
+def installwebsite(options):
+    """Rebuild and copy website files to the remote server.
+    """
+    # Clean up
+    remake_directories(options.website.builddir)
+    # Rebuild
+    website(options)
+    # Copy to the server
+    os.environ['RSYNC_RSH'] = '/usr/bin/ssh'
+    src_path = path(options.website.builddir) / 'html'
+    sh('cd %s; rsync --archive --delete --verbose . %s:%s' % 
+        (src_path, options.website.server, options.website.server_path))
     return
 
+
 @task
 @needs(['html',
         'generate_setup', 'minilib', 

docsource/make.bat

@@ -25,7 +25,7 @@
 extensions = []
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ['templates']
 
 # The suffix of source filenames.
 source_suffix = '.rst'
@@ -120,7 +120,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ['static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.