openstack/heat
Code Issues Proposed changes
heat/doc
History
Dmitriy Uvarenkov afeee484a4 Remove usages of :linenos: in docs 
Some markup features are sphinx-specific and
are not supported by current library. Some bug were
reported https://bugs.launchpad.net/doc8/+bug/1426503
about this, but it is not fixed and we need working
docs.
In current situation whole blocks of code are not shown
so i removed usages of error-inflicting directive :linenos:

Change-Id: I25e2d193b10d713bbe64fb227afb71310874bb9f
2016-05-12 18:36:37 +03:00
..
docbkx
Replace github with openstack git repo
2015-10-21 09:51:40 +08:00
source
Remove usages of :linenos: in docs
2016-05-12 18:36:37 +03:00
.gitignore
A new documention structure, ready for contributions
2012-12-19 10:22:35 +13:00
Makefile
Makefile option to build xml docs
2014-07-02 22:08:01 +02:00
README.rst
Switch over to oslosphinx
2014-02-13 18:45:57 +01:00

README.rst

Building the developer docs

For user and admin docs, go to the directory doc/docbkx.

Dependencies

You'll need to install python Sphinx package and oslosphinx package:

sudo pip install sphinx oslosphinx

If you are using the virtualenv you'll need to install them in the virtualenv.

Get Help

Just type make to get help:

make

It will list available build targets.

Build Doc

To build the man pages:

make man

To build the developer documentation as HTML:

make html

Type make for more formats.

Test Doc

If you modify doc files, you can type:

make doctest

to check whether the format has problem.