Roundup Tracker - Issues

Issue 2550545

classification
Title: README.txt: Instructions for building the documentation outdated.
Type: Severity: normal
Components: Documentation Versions: devel, 1.4
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: stefan Nosy List: ber, eric.araujo, richard, stefan
Priority: Keywords:

Created on 2009-05-07 19:25 by ber, last changed 2010-11-17 21:41 by eric.araujo.

Messages
msg3702 (view) Author: [hidden] (ber) Date: 2009-05-07 19:25
Version 1.4.8
official tarball
README.txt has
  The *.txt files in the "doc" directory are written in 
reStructedText. If
  you have rst2html installed (part of the docutils suite) you can 
convert
  these to HTML by running "make html" in the "doc" directory.

There is no makefile in "doc".
   python setup.py build_doc
is not mentioned, which needs
        roundup/dist/command/build_doc.py
                sphinx = find_executable('sphinx-build')

Which is an (optional?) prerequisite which should be mentioned
in installation.txt I guess.
msg3728 (view) Author: [hidden] (stefan) Date: 2009-06-17 14:36
The current procedure to build documentation is 'python setup.py
build_doc'. Doing this will result in HTML docs put into
share/doc/roundup/html/. Richard, I would suggest to run this prior to
all packaging, such that all source and binary packages contain these
HTML docs. Then, we can adjust the toplevel README.txt to point to those.

If we run the 'build_doc' command prior to any packaging, there is no
need for anybody but us to have sphinx installed (and so it doesn't
become a prerequisite for Roundup users).

Does this make sense ?
msg3729 (view) Author: [hidden] (ber) Date: 2009-06-17 14:42
I think it is good to build the documentation before packaging.
(I haven't checked the repository, but I think you should directly change
the instructions in the repository for people trying the latest revision.)
msg3734 (view) Author: [hidden] (richard) Date: 2009-06-18 00:10
Sure, sounds like a good idea to me.
History
Date User Action Args
2010-11-17 21:41:17eric.araujosetnosy: + eric.araujo
2009-06-18 00:10:31richardsetmessages: + msg3734
2009-06-17 14:42:57bersetmessages: + msg3729
2009-06-17 14:36:21stefansetstatus: new -> open
assignee: stefan
messages: + msg3728
nosy: + richard
2009-05-07 19:25:05bercreate