openstack/heat
Code Issues Proposed changes

Drop outdated README file for documentation

Browse Source 
This file has been unmaintained for long time.

Change-Id: Ib8c230045e3b714eddbeb21aac17fa6a95986e31
Signed-off-by: Takashi Kajinami <kajinamit@oss.nttdata.com>
This commit is contained in:
Takashi Kajinami
2025-08-06 22:17:54 +09:00
parent 10656f4c7e
commit 4c9cafc7a9
1 changed files with 0 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
doc/README.rst
View File

@@ -1,57 +0,0 @@
===========================
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.