← Back to branch summary

~ivoks/charm-helpers/ssh_ip

« back to all changes in this revision

Viewing changes to HACKING

  • Committer: Tim Van Steenburgh
  • Date: 2014-06-09 17:25:52 UTC
  • mto: This revision was merged to the branch mainline in revision 173.
  • Revision ID: tim.van.steenburgh@canonical.com-20140609172552-bgruefsywu505pg8
Add HACKING doc

Show diffs side-by-side

added added

removed removed

Lines of Context:
HACKING
 
1
Hacking on Docs
 
2
---------------
 
3
 
 
4
To build the html documentation::
 
5
 
 
6
  make docs
 
7
 
 
8
To browse the html documentation locally::
 
9
 
 
10
  make docs
 
11
  cd docs/_build/html
 
12
  python -m SimpleHTTPServer 8765
 
13
  # point web browser to http://localhost:8765
 
14
 
 
15
To build and upload package and doc updates to PyPI::
 
16
 
 
17
  make release
 
18
  # note: if the package version already exists on PyPI
 
19
  # this command will upload doc updates only
 
20
 
 
21
 
 
22
PyPI Package and Docs
 
23
---------------------
 
24
 
 
25
The published package and docs currently live at:
 
26
 
 
27
  https://pypi.python.org/pypi/charmhelpers
 
28
  http://pythonhosted.org/charmhelpers/