Hello Sphinx Users, Developers and Fans, Today we added support for Python 3.x to Sphinx and we would like to invite you to test it, to play around with it and to see if it works with your existing Python 3.x projects.
In order to install it locally we recommend using virtualenv3 or virtualenv5 (I tested it with the latter) which allows you to cleanly install dependencies for development or if you simply if you want to test a Python application without changing the global environment. To clone the repository you also need Mercurial, the DVCS we use for development. First of all you cd into a directory and clone the repo, the result should look like this. ~# cd Projects Projects# hg clone http://bitbucket.org/birkenfeld/sphinx destination directory: sphinx requesting all changes adding changesets adding manifests adding file changes added 2501 changesets with 8773 changes to 1513 files updating to branch default 391 files updated, 0 files merged, 0 files removed, 0 files unresolved Then we cd into the directory and create the virtualenv, make sure that virtualenv uses python3 for the env, once it's created we can activate it: Projects# cd sphinx sphinx# virtualenv5 env New python executable in env/bin/python3.1 Also creating executable in env/bin/python Installing setuptools........................................................................................................................................................................................................................................................................................................................................done. sphinx# source env/bin/activate (env)sphinx# Once it's activated you will notice the (env) at the beginning of the prompt, now we can install the dependencies: (env)sphinx# easy_install docutils pygments jinja2 install_dir /home/dasich/Projects/sphinx/env/lib64/python3.1/site-packages/ Searching for docutils Reading http://pypi.python.org/simple/docutils/ Reading http://docutils.sourceforge.net/ Best match: docutils 0.7 Downloading http://pypi.python.org/packages/source/d/docutils/docutils-0.7.tar.gz#md5=9aec716baf15d06b5aa57cf8d5591c15 Processing docutils-0.7.tar.gz Running docutils-0.7/setup.py -q bdist_egg --dist-dir /tmp/easy_install-cpiGhF/docutils-0.7/egg-dist-tmp-e1oOBJ "roman" module already present; ignoring extras/roman.py. warning: no files found matching 'MANIFEST' warning: no previously-included files matching '.cvsignore' found under directory '*' warning: no previously-included files matching '*.pyc' found under directory '*' warning: no previously-included files matching '*~' found under directory '*' warning: no previously-included files matching '.DS_Store' found under directory '*' copying aux dirs zip_safe flag not set; analyzing archive contents... docutils.writers.pep_html.__init__: module references __file__ docutils.writers.odf_odt.__init__: module references __file__ docutils.writers.s5_html.__init__: module references __file__ docutils.writers.latex2e.__init__: module references __file__ docutils.writers.newlatex2e.__init__: module references __file__ docutils.writers.html4css1.__init__: module references __file__ docutils.parsers.rst.directives.misc: module references __file__ tools.dev.profile_docutils: module references __file__ test.DocutilsTestSupport: module references __file__ test.DocutilsTestSupport: module MAY be using inspect.getouterframes test.test_language: module references __path__ test.alltests: module references __file__ test.test_readers.__init__: module references __file__ test.test_readers.test_python.__init__: module references __file__ test.test_readers.test_pep.__init__: module references __file__ test.test_parsers.__init__: module references __file__ test.test_parsers.test_rst.__init__: module references __file__ test.test_parsers.test_rst.test_directives.__init__: module references __file__ test.test_parsers.test_rst.test_directives.test_include: module references __file__ test.test_writers.__init__: module references __file__ test.test_transforms.__init__: module references __file__ Adding docutils 0.7 to easy-install.pth file Installing rst2newlatex.py script to /home/dasich/Projects/sphinx/env/bin Installing rst2html.py script to /home/dasich/Projects/sphinx/env/bin Installing rst2odt_prepstyles.py script to /home/dasich/Projects/sphinx/env/bin Installing rst2s5.py script to /home/dasich/Projects/sphinx/env/bin Installing rst2man.py script to /home/dasich/Projects/sphinx/env/bin Installing rst2latex.py script to /home/dasich/Projects/sphinx/env/bin Installing rst2xml.py script to /home/dasich/Projects/sphinx/env/bin Installing rst2pseudoxml.py script to /home/dasich/Projects/sphinx/env/bin Installing rst2odt.py script to /home/dasich/Projects/sphinx/env/bin Installing rstpep2html.py script to /home/dasich/Projects/sphinx/env/bin Installed /home/dasich/Projects/sphinx/env/lib/python3.1/site-packages/docutils-0.7-py3.1.egg Processing dependencies for docutils Finished processing dependencies for docutils Searching for pygments Reading http://pypi.python.org/simple/pygments/ Reading http://pygments.org/ Reading http://pygments.pocoo.org/ Best match: Pygments 1.3.1 Downloading http://pypi.python.org/packages/source/P/Pygments/Pygments-1.3.1.tar.gz#md5=54be67c04834f13d7e255e1797d629a5 Processing Pygments-1.3.1.tar.gz Running Pygments-1.3.1/setup.py -q bdist_egg --dist-dir /tmp/easy_install-I4qqDa/Pygments-1.3.1/egg-dist-tmp-6QJPM5 Adding Pygments 1.3.1 to easy-install.pth file Installing pygmentize script to /home/dasich/Projects/sphinx/env/bin Installed /home/dasich/Projects/sphinx/env/lib/python3.1/site-packages/Pygments-1.3.1-py3.1.egg Processing dependencies for pygments Finished processing dependencies for pygments Searching for jinja2 Reading http://pypi.python.org/simple/jinja2/ Reading http://jinja.pocoo.org/ Best match: Jinja2 2.5 Downloading http://pypi.python.org/packages/source/J/Jinja2/Jinja2-2.5.tar.gz#md5=d02f82e33afe918cef8a9abcd23ccd78 Processing Jinja2-2.5.tar.gz Running Jinja2-2.5/setup.py -q bdist_egg --dist-dir /tmp/easy_install-SC55hg/Jinja2-2.5/egg-dist-tmp-788UfT warning: no previously-included files matching '*' found under directory 'docs/_build/doctrees' warning: no previously-included files matching '*.pyc' found under directory 'jinja2' warning: no previously-included files matching '*.pyc' found under directory 'docs' warning: no previously-included files matching '*.pyo' found under directory 'jinja2' warning: no previously-included files matching '*.pyo' found under directory 'docs' Adding Jinja2 2.5 to easy-install.pth file Installed /home/dasich/Projects/sphinx/env/lib/python3.1/site-packages/Jinja2-2.5-py3.1.egg Processing dependencies for jinja2 Finished processing dependencies for jinja2 This is it already, Sphinx should now be successfully installed but better safe than sorry so run the test suite, this creates a lot of output so I won't paste everything here (env)sphinx# make test ... Running Sphinx test suite... .................................................................................................................................................................................... ---------------------------------------------------------------------- Ran 180 tests in 21.283s OK The important part is the part at the end. If for some reason the tests fail please reply with a message and the complete output of make test following the line "Running Sphinx test suite...". If you get the same result I got you can now start experimenting with sphinx. If you want to leave the virtualenv simply type "deactivate" in the shell and press enter. If you delete the folder created by the hg clone command everything we installed will be deleted without having any effect on your system. Have fun testing :) -- You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To post to this group, send email to sphinx-...@googlegroups.com. To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
