Commits

Doug Hellmann committed e758287

more doc build changes

Comments (0)

Files changed (8)

 2011-02-26  Doug Hellmann  <dhellmann@racemi.com>
 
+	* docs/sphinx/conf.py: Just hard-code the version.
+
+	* setup.py: Just hard-code the version.
+
 	* virtualenvwrapper/version.py: Put the version info inside the
 	package so it is available to the doc build and packaging
 	script. This also makes the readthedocs.org build work properly.
 	@echo "html           - HTML documentation"
 	@echo "docclean       - Remove documentation build files"
 	@echo "upload         - upload a new release to PyPI"
-	@echo "website        - build web version of docs"
-	@echo "installwebsite - deploy web version of docs"
 	@echo "develop        - install development version"
 	@echo "test           - run the test suite"
 	@echo "test-quick     - run the test suite for bash and one version of Python ($(PYTHON26))"
-
+	@echo "website        - generate web version of the docs"
+	@echo "installwebsite - copy web version of HTML docs up to server"
 
 .PHONY: sdist
 sdist: html
 website: 
 	[ ~/Devel/doughellmann/doughellmann/templates/base.html -nt docs/sphinx/web/templates/base.html ] && (echo "Updating base.html" ; cp ~/Devel/doughellmann/doughellmann/templates/base.html docs/sphinx/web/templates/base.html) || exit 0
 	rm -rf docs/website
-	(cd docs && $(MAKE) html BUILDING_WEB=1 BUILDDIR="website/en" LANGUAGE="en")
-	(cd docs && $(MAKE) html BUILDING_WEB=1 BUILDDIR="website/es" LANGUAGE="es")
-	(cd docs && $(MAKE) html BUILDING_WEB=1 BUILDDIR="website/ja" LANGUAGE="ja")
+	(cd docs && $(MAKE) html BUILDDIR="website/en" LANGUAGE="en")
+	(cd docs && $(MAKE) html BUILDDIR="website/es" LANGUAGE="es")
+	(cd docs && $(MAKE) html BUILDDIR="website/ja" LANGUAGE="ja")
 
 installwebsite: website
 	(cd docs/website/en && rsync --rsh=ssh --archive --delete --verbose . www.doughellmann.com:/var/www/doughellmann/DocumentRoot/docs/virtualenvwrapper/)

docs/en/history.rst

 Release History
 ===============
 
-Dev
+2.6.3
 
+  - Hard-code the version information in the setup.py and conf.py
+    scripts so it works for http://readthedocs.org.
+
+2.6.2
+
+  - Attempted to make the doc build work with http://readthedocs.org.
   - Merged in `Japanese translation of the documentation
     <http://www.doughellmann.com/docs/virtualenvwrapper/ja/>`__ from
     Tetsuya Morimoto.

docs/sphinx/conf.py

 bitbucket_project_url = 'http://bitbucket.org/dhellmann/virtualenvwrapper/'
 
 # Add any paths that contain templates here, relative to this directory.
-if building_web:
-    templates_path = ['web/templates']
-else:
-    templates_path = ['pkg/templates']
+#templates_path = ['pkg/templates']
 
 # The suffix of source filenames.
 source_suffix = '.rst'
 
 # General information about the project.
 project = u'virtualenvwrapper'
-copyright = u'2009, Doug Hellmann'
+copyright = u'2009-2011, Doug Hellmann'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-import virtualenvwrapper.version
-version = virtualenvwrapper.version.VERSION
+version = '2.6.3'
 # The full version, including alpha/beta/rc tags.
 release = version
 
 
 # The theme to use for HTML and HTML Help pages.  Major themes that come with
 # Sphinx are currently 'default' and 'sphinxdoc'.
-if building_web:
-    html_theme = 'default'
-else:
-    html_theme = 'sphinxdoc'
+html_theme = 'nature'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

docs/sphinx/web/templates/base.html

-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>{% block title %}Doug Hellmann{% endblock %}</title>
-{% block head_before_css %}
-{% endblock %}
-<link href="/static/css/leaves.css" rel="stylesheet" type="text/css" />
-{% block head_after_css %}
-{% endblock %}
-{% block head %}
-{% endblock %}
-<meta name="verify-v1" content="5saTcOa2HLac4V85yUg3SARfun1PqT5Upu7IR/6fpv4="/>
-</head>
-<body>
-    
-<div id="container">
-    
-<div id="header">
-  <h1>{% block page_heading %}Doug Hellmann{% endblock %}</h1>
-  <p>{% block page_subheading %}{% endblock %}</p>
-  <a id="admin-link" href="/admin/">admin</a>
-</div>
-
-<div id="sidebar_left_wrapper">
-
-<div id="navigation"> 
-	<ul id="navlist">
-		<li><a href="/">Home</a></li>
-		<li><a href="/PyMOTW/">PyMOTW</a></li>
-		<li><a href="http://blog.doughellmann.com/" target="_">Blog</a></li>
-		<li><a href="/articles/">Articles</a></li>
-		<li><a href="/projects/">Projects</a></li>
-		<li><a href="http://code.doughellmann.com/" target="_">Code</a></li>
-		<li><a href="/about/">About</a></li>
-	</ul>
-</div>
-
-{% block sidebar_l %}
-{% endblock %}
-</div>
-
-<div id="sidebar">
-{% block sidebar %}
-
-    <h2>Sidebar</h2>
-    <p>You have reached the sidebar, put news, links, or anything textual in here. I think I'll drag on with typing nonsense text, until you feel really really sleepy. Of course, you wouldn't waste time reading this. Some Latin would be more useful.</p>
-{% endblock %}
-    
-    <p class="ads">
-    <script type="text/javascript"><!--
-    google_ad_client = "pub-3205160560229413";
-    google_ad_width = 120;
-    google_ad_height = 600;
-    google_ad_format = "120x600_as";
-    google_ad_type = "text";
-    //2007-10-27: www.doughellmann.com
-    google_ad_channel = "0828653884";
-    google_color_border = "FFFFFF";
-    google_color_bg = "FFFFFF";
-    google_color_link = "CC6714";
-    google_color_text = "000000";
-    google_color_url = "999999";
-    google_ui_features = "rc:0";
-    //-->
-    </script>
-    <script type="text/javascript"
-      src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
-    </script>
-    </p>
-
-</div>
-	  
-<div id="content">
-{% block content %}
-{% block relbar1 %}{% endblock %}
-
-  <h2>Welcome to Leaves.</h2>
-  <p>Welcome to Leaves, a static, 3 column layout made with your usual CSS and XHTML. It is able to correctly accommodate any font size increases or shrinkages (Is that a word?). It seems to work fine in Firefox, Opera, Internet Explorer and Safari. It's more minimal than other designs, because I think images (drop shadows, giant header images) are being obsessively over used these days. I think it detracts from the content and shoves way too much information to a viewer all at the same time, so here you go: Leaves, a minimalist design. Feel free to massacre or change the design to your liking. Well, I guess it's time for some more Latin. <strong>If you want me to create a custom design for you, feel free to drop me a line anytime at web@smallpark.org </strong></p>
-
-{% block relbar2 %}{% endblock %}
-{% endblock %}
-
-{% block addthis %}
-<div id="addthis"><a href="http://www.addthis.com/bookmark.php" onclick="addthis_url   = location.href; addthis_title = document.title; return addthis_click(this);" target="_blank"><img src="http://s7.addthis.com/static/btn/lg-share-en.gif" width="125" height="16" border="0" alt="Bookmark and Share" /></a><script type="text/javascript">var addthis_pub = "dhellmann";</script><script type="text/javascript" src="http://s7.addthis.com/js/widget.php?v=10"></script></div>
-{% endblock %}
-
-{% block comments %}
-<!-- Disqus -->
-<div id="disqus_wrapper">
-<div id="disqus_thread"></div><script type="text/javascript" src="http://disqus.com/forums/doughellmann/embed.js"></script><noscript><a href="http://doughellmann.disqus.com/?url=ref">View the discussion thread.</a></noscript><a href="http://disqus.com" class="dsq-brlink">blog comments powered by <span class="logo-disqus">Disqus</span></a>
-</div>
-{% endblock %}
-</div>
-
-<div id="footer_ads">
-
-    <p><script type="text/javascript"><!--
-    google_ad_client = "pub-3205160560229413";
-    google_ad_width = 728;
-    google_ad_height = 90;
-    google_ad_format = "728x90_as";
-    google_ad_type = "text";
-    //2007-10-21: www.doughellmann.com
-    google_ad_channel = "0828653884";
-    google_color_border = "FFFFFF";
-    google_color_bg = "FFFFFF";
-    google_color_link = "CC6714";
-    google_color_text = "000000";
-    google_color_url = "999999";
-    google_ui_features = "rc:0";
-    //-->
-    </script>
-    <script type="text/javascript"
-      src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
-    </script></p>
-</div>
-
-<div id="footer">
- {% block footer %}
-    
-<p>Copyright Doug Hellmann | Design based on "Leaves" by <a href="http://smallpark.org">SmallPark</a></p>
-   
-    <script src="http://www.google-analytics.com/urchin.js"
-    type="text/javascript">
-    </script>
-    <script type="text/javascript">
-      _uacct = "UA-1847381-1";
-      urchinTracker();
-    </script>
-
- {% endblock %}
-</div>
-
-</div>
-
-<!-- Disqus -->
-<script type="text/javascript">
-//<![CDATA[
-(function() {
-		var links = document.getElementsByTagName('a');
-		var query = '?';
-		for(var i = 0; i < links.length; i++) {
-			if(links[i].href.indexOf('#disqus_thread') >= 0) {
-				query += 'url' + i + '=' + encodeURIComponent(links[i].href) + '&';
-			}
-		}
-		document.write('<script type="text/javascript" src="http://disqus.com/forums/doughellmann/get_num_replies.js' + query + '"></' + 'script>');
-	})();
-//]]>
-</script>
-
-
-</body>
-</html>

docs/sphinx/web/templates/layout.html

-{% extends "base.html" %}
-
-{% block title %}{{ title }} - {{ project }}{% endblock %}
-
-{% block head_before_css %}
-<link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" 
-    type="text/css" />
-<style>
-    body {
-        margin: 8px;
-    }
-    .highlight {
-        background-color: white;
-        border: 0;
-    }
-    .highlight pre {
-        background-color: white;
-    }
-</style>
-{% endblock %}
-
-{% block head %}
-<script type="text/javascript">
-  var DOCUMENTATION_OPTIONS = {
-      URL_ROOT:    '{{ pathto("", 1) }}',
-      VERSION:     '{{ release }}',
-      COLLAPSE_MODINDEX: false,
-      FILE_SUFFIX: '{{ file_suffix }}'
-  };
-</script>
-
-<script type="text/javascript" src="{{ pathto('_static/jquery.js', 1) }}"></script>
-<script type="text/javascript" src="{{ pathto('_static/doctools.js', 1) }}"></script>
-
-{%- block rellinks %}
-    {%- if hasdoc('about') %}
-    <link rel="author" title="About these documents" href="{{ pathto('about') }}" />
-    {%- endif %}
-    <link rel="contents" title="Global table of contents" href="{{ pathto('contents') }}" />
-    <link rel="index" title="Global index" href="{{ pathto('genindex') }}" />
-    {%- if hasdoc('copyright') %}
-    <link rel="copyright" title="Copyright" href="{{ pathto('copyright') }}" />
-    {%- endif %}
-    <link rel="top" title="{{ docstitle }}" href="{{ pathto('index') }}" />
-    {%- if parents %}
-    <link rel="up" title="{{ parents[-1].title|striptags }}" href="{{ parents[-1].link|e }}" />
-    {%- endif %}
-    {%- if next %}
-    <link rel="next" title="{{ next.title|striptags }}" href="{{ next.link|e }}" />
-    {%- endif %}
-    {%- if prev %}
-    <link rel="prev" title="{{ prev.title|striptags }}" href="{{ prev.link|e }}" />
-    {%- endif %}
-{%- endblock %}
-{% endblock %}
-    
-{% block sidebar %}
-{%- block sidebartoc %}
-{%- if display_toc %}
-  <h3>Page Contents</h3>
-  {{ toc }}
-{%- endif %}
-{%- endblock %}
-
-    <h3>Navigation</h3>
-    <a href="/docs/{{project}}/">Top</a><br/>
-{% if next or prev %}
-    {%- if prev %}
-      <a href="{{ prev.link|e }}" title="previous chapter">Previous: {{ prev.title }}</a><br/>
-    {%- endif %}
-
-    {%- if next %}
-      <a href="{{ next.link|e }}" title="next chapter">Next: {{ next.title }}</a><br/>
-    {%- endif %}
-{% endif %}
-    <a href="/projects/{{project}}/">{{project}} Home</a><br/>
-
-    {%- if show_source and has_source and sourcename %}
-      <h3>{{ _('This Page') }}</h3>
-      <a href="{{ pathto('_sources/' + sourcename, true)|e }}"
-               rel="nofollow">{{ _('Show Source') }}</a>
-      </ul>
-    {%- endif %}
-
-    <p>
-  <a href="http://creativecommons.org/licenses/by-nc-sa/3.0/us/" rel="license"><img alt="Creative Commons License" style="border-width:0; align: center;" src="http://i.creativecommons.org/l/by-nc-sa/3.0/us/88x31.png"/></a>
-    </p>
-{% endblock %}
-
-{% block sidebar_l %}
-{% endblock %}
-
-{% block content %}
-{% block body %}{% endblock %}
-{% endblock %}
-
-{% block footer %}
-<p>
-  {%- if hasdoc('copyright') %}
-    <a href="{{ pathto('copyright') }}">&copy; Copyright </a> {{ copyright }}.
-  {%- else %}
-    &copy; Copyright {{ copyright }}.
-  {%- endif %}
-  {%- if last_updated %}
-    | Last updated on {{ last_updated }}.
-  {%- endif %}
-  {%- if show_sphinx %}
-   | Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
-  {%- endif %}
-   | Design based on "Leaves" by <a href="http://smallpark.org">SmallPark</a>
-</p>
-   
-<script src="http://www.google-analytics.com/urchin.js" type="text/javascript" />
-<script type="text/javascript">
-  _uacct = "UA-1847381-1";
-  urchinTracker();
-</script>
-{% endblock %}
 #!/usr/bin/env python
 
-import virtualenvwrapper.version
+PROJECT = 'virtualenvwrapper'
 
-PROJECT = 'virtualenvwrapper'
-VERSION = virtualenvwrapper.version.VERSION
+# Change docs/sphinx/conf.py too!
+VERSION = '2.6.3'
 
 # Bootstrap installation of Distribute
 import distribute_setup

virtualenvwrapper/version.py

-#!/usr/bin/env python
-# encoding: utf-8
-#
-# Copyright (c) 2011 Doug Hellmann.  All rights reserved.
-#
-"""Version info for virtualenvwrapper base system.
-"""
-
-VERSION = '2.6.2'
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.