Django

Code

Ticket #1527 (closed: duplicate)

Opened 2 years ago

Last modified 1 year ago

Makefile for HTML documentation

Reported by: Andy Dustman <farcepest@gmail.com> Assigned to: jacob
Milestone: Component: Documentation
Version: SVN Keywords:
Cc: farcepest@gmail.com Triage Stage: Accepted
Has patch: 0 Needs documentation: 0
Needs tests: 0 Patch needs improvement: 0

Description

I wanted to be able to read the current SVN docs as HTML, so I put together a small Makefile (to go in the docs directory): 

.SUFFIXES = .txt .html

%.html : %.txt
        rst2html.py $< $@

objects := $(patsubst %.txt,%.html,$(wildcard *.txt))
all: $(objects)

Assumes docutils and rst2html.py on your path, and GNU Make. Running make processes any .txt files to .html as needed. Will add as an attachment too to preserve tabs.

Attachments

Makefile (129 bytes) - added by Andy Dustman <farcepest@gmail.com> on 03/21/06 14:24:37.
Makefile for docs to convert ReST -> HTML

Change History

03/21/06 14:24:37 changed by Andy Dustman <farcepest@gmail.com>

  • attachment Makefile added.

Makefile for docs to convert ReST -> HTML

03/21/06 14:29:19 changed by adrian

Whoa, this is pretty cool. Thanks!

05/26/06 20:45:30 changed by Andy Dustman <farcepest@gmail.com>

  • cc set to farcepest@gmail.com.
  • version changed from magic-removal to SVN.

Switched to SVN version since magic-removal is no longer relevant.

05/31/06 12:27:03 changed by Andy Dustman <farcepest@gmail.com>

buildhtml.py which comes with distutils will also do the same job, although it always rebuilds everything, unlike make which only rebuilds when the source is modified.

08/13/06 00:41:41 changed by Gary Wilson <gary.wilson@gmail.com>

  • milestone changed from Version 0.92 to Version 1.0.

0.92 is long gone.

01/17/07 16:12:17 changed by

  • milestone deleted.

Milestone Version 1.0 deleted

01/18/07 02:40:47 changed by Simon G. <dev@simon.net.nz>

  • stage changed from Unreviewed to Accepted.

Accepted on the basis of "whoa, this is cool!"

05/19/07 19:39:58 changed by Marc Fargas <telenieko@telenieko.com>

  • status changed from new to closed.
  • resolution set to duplicate.

I think we can mark this as a duplicate of #528, #528 is about a PDF/HTML generator. On the other hand this patch requires make and rst2html.py and the first one can be a bit tricky to have on some platforms (win..)

So, marking as duplicate of #528 ;)

Add/Change #1527 (Makefile for HTML documentation)




Change Properties
Action