Skip to content

Commit 7133181

Browse files
committed
more doc build changes
1 parent b1ca52e commit 7133181

8 files changed

Lines changed: 23 additions & 303 deletions

File tree

‎ChangeLog‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
2011-02-26 Doug Hellmann <dhellmann@racemi.com>
22

3+
* docs/sphinx/conf.py: Just hard-code the version.
4+
5+
* setup.py: Just hard-code the version.
6+
37
* virtualenvwrapper/version.py: Put the version info inside the
48
package so it is available to the doc build and packaging
59
script. This also makes the readthedocs.org build work properly.

‎Makefile‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,11 @@ help:
44
@echo "html - HTML documentation"
55
@echo "docclean - Remove documentation build files"
66
@echo "upload - upload a new release to PyPI"
7-
@echo "website - build web version of docs"
8-
@echo "installwebsite - deploy web version of docs"
97
@echo "develop - install development version"
108
@echo "test - run the test suite"
119
@echo "test-quick - run the test suite for bash and one version of Python ($(PYTHON26))"
12-
10+
@echo "website - generate web version of the docs"
11+
@echo "installwebsite - copy web version of HTML docs up to server"
1312

1413
.PHONY: sdist
1514
sdist: html
@@ -34,9 +33,9 @@ docclean:
3433
website:
3534
[ ~/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
3635
rm -rf docs/website
37-
(cd docs && $(MAKE) html BUILDING_WEB=1 BUILDDIR="website/en" LANGUAGE="en")
38-
(cd docs && $(MAKE) html BUILDING_WEB=1 BUILDDIR="website/es" LANGUAGE="es")
39-
(cd docs && $(MAKE) html BUILDING_WEB=1 BUILDDIR="website/ja" LANGUAGE="ja")
36+
(cd docs && $(MAKE) html BUILDDIR="website/en" LANGUAGE="en")
37+
(cd docs && $(MAKE) html BUILDDIR="website/es" LANGUAGE="es")
38+
(cd docs && $(MAKE) html BUILDDIR="website/ja" LANGUAGE="ja")
4039

4140
installwebsite: website
4241
(cd docs/website/en && rsync --rsh=ssh --archive --delete --verbose . www.doughellmann.com:/var/www/doughellmann/DocumentRoot/docs/virtualenvwrapper/)

‎docs/en/history.rst‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,14 @@
22
Release History
33
===============
44

5-
Dev
5+
2.6.3
66

7+
- Hard-code the version information in the setup.py and conf.py
8+
scripts so it works for http://readthedocs.org.
9+
10+
2.6.2
11+
12+
- Attempted to make the doc build work with http://readthedocs.org.
713
- Merged in `Japanese translation of the documentation
814
<http://www.doughellmann.com/docs/virtualenvwrapper/ja/>`__ from
915
Tetsuya Morimoto.

‎docs/sphinx/conf.py‎

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,7 @@
2929
bitbucket_project_url = 'http://bitbucket.org/dhellmann/virtualenvwrapper/'
3030

3131
# Add any paths that contain templates here, relative to this directory.
32-
if building_web:
33-
templates_path = ['web/templates']
34-
else:
35-
templates_path = ['pkg/templates']
32+
#templates_path = ['pkg/templates']
3633

3734
# The suffix of source filenames.
3835
source_suffix = '.rst'
@@ -45,15 +42,14 @@
4542

4643
# General information about the project.
4744
project = u'virtualenvwrapper'
48-
copyright = u'2009, Doug Hellmann'
45+
copyright = u'2009-2011, Doug Hellmann'
4946

5047
# The version info for the project you're documenting, acts as replacement for
5148
# |version| and |release|, also used in various other places throughout the
5249
# built documents.
5350
#
5451
# The short X.Y version.
55-
import virtualenvwrapper.version
56-
version = virtualenvwrapper.version.VERSION
52+
version = '2.6.3'
5753
# The full version, including alpha/beta/rc tags.
5854
release = version
5955

@@ -99,10 +95,7 @@
9995

10096
# The theme to use for HTML and HTML Help pages. Major themes that come with
10197
# Sphinx are currently 'default' and 'sphinxdoc'.
102-
if building_web:
103-
html_theme = 'default'
104-
else:
105-
html_theme = 'sphinxdoc'
98+
html_theme = 'nature'
10699

107100
# Theme options are theme-specific and customize the look and feel of a theme
108101
# further. For a list of options available for each theme, see the

‎docs/sphinx/web/templates/base.html‎

Lines changed: 0 additions & 155 deletions
This file was deleted.

‎docs/sphinx/web/templates/layout.html‎

Lines changed: 0 additions & 118 deletions
This file was deleted.

‎setup.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
#!/usr/bin/env python
22

3-
import virtualenvwrapper.version
4-
53
PROJECT = 'virtualenvwrapper'
6-
VERSION = virtualenvwrapper.version.VERSION
4+
5+
# Change docs/sphinx/conf.py too!
6+
VERSION = '2.6.3'
77

88
# Bootstrap installation of Distribute
99
import distribute_setup

‎virtualenvwrapper/version.py‎

Lines changed: 0 additions & 9 deletions
This file was deleted.

0 commit comments

Comments
 (0)