These are rough notes at the moment.  Published to here:

Docs are built using Sphinx

To make uploading easy, install sphinx-pypi-upload via pip.

make html
sphinx-build -b html -d build/doctrees   source build/html
Making output directory...
Running Sphinx v1.2b2
loading pickled environment... not yet created
building [html]: targets for 1 source files that are out of date
updating environment: 1 added, 0 changed, 0 removed
reading sources... [100%] index
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] index
writing additional files... (0 module code pages) genindex search
copying static files... done
copying extra files... dumping search index... done
dumping object inventory... done
build succeeded.

Build finished. The HTML pages are in build/html.

sphinx-apidoc -o source ../cloudmonkey
Creating file source/cloudmonkey.rst.
Creating file source/modules.rst.

I had to run this:

python register
running register
running egg_info
writing requirements to cloudmonkey.egg-info/requires.txt
writing cloudmonkey.egg-info/PKG-INFO
writing top-level names to cloudmonkey.egg-info/top_level.txt
writing dependency_links to cloudmonkey.egg-info/dependency_links.txt
writing entry points to cloudmonkey.egg-info/entry_points.txt
reading manifest file 'cloudmonkey.egg-info/SOURCES.txt'
writing manifest file 'cloudmonkey.egg-info/SOURCES.txt'
running check
We need to know who you are, so please choose either:
 1. use your existing login,
 2. register as a new user,
 3. have the server generate a new password for you (and email it to you), or
 4. quit
Your selection [default 1]:
Username: chip.childers
Registering cloudmonkey to
Server response (200): OK
I can store your PyPI login so future submissions will be faster.
(the login will be stored in /Users/chip.childers/.pypirc)
Save your login (y/N)?y

python upload_sphinx
running upload_sphinx
Submitting documentation to
Upload successful. Visit
  • No labels