Commit Graph

4 Commits

Author SHA1 Message Date
Dirk Mueller
e53f7792ad Switch over to oslosphinx
oslosphinx is now available as a replacement for oslo.sphinx that
won't conflict with oslo.config in virtual envs

Change-Id: I7dc3349c8102cc8f358de7e0088128b6705c5f8e
Closes-Bug: #1277168
2014-02-13 18:45:57 +01:00
Pavlo Shchelokovskyy
3ea6e8c54f Fix a typo in the README for docs
Package `oslo.sphinx` is wronlgy referred to as `oslo-sphinx`.

Change-Id: I15711aa54c82d97b622fbceb821b4aca3315d49c
2013-12-24 16:08:41 +02:00
JUN JIE NAN
cd77745003 Doc usage enhancement
Enable doctest, correct depenencies section, adjust help and build
section.

Change-Id: I6c2f89d64926ee8e32b86299356700446903888b
2013-11-19 14:08:17 +08:00
Steve Baker
c4777794e7 A new documention structure, ready for contributions
Here are some skeletons for the documentation which will need to be written.

doc/source
	A Sphinx based document which will be aimed at heat developers.
    	This also contains .rst files which generate the man files
doc/docbkx/api-ref
	Docbook and WADL for the REST API, with the intent of moving this
	to api-site to publish to api.openstack.org
doc/docbkx/heat-admin
	Docbook manual targeted at Heat admins, with the intent of moving this
        to openstack-manuals to publish to docs.openstack.org
doc/docbkx/heat-cli
	Docbook manual targeted at users of the Heat CLI, with the intent of
	moving this to openstack-manuals to publish to docs.openstack.org

Dude, wheres my man pages?
docs/man
	is deleted, now generated into doc/build/man

Packaging will need to be updated to generate the man pages

Change-Id: Idf2f37086b6f97df18ed57172de2f9e3d4c7706a
2012-12-19 10:22:35 +13:00