upstream/mercurial-mirror Files · doc/Makefile

doc: gendoc.py creates valid output for option descriptions with newlines...

doc: gendoc.py creates valid output for option descriptions with newlines gendoc.py did not handle the hanging indentation for descriptions. Work around this by joining all in one single line (same as in minirst since previous patch). This problem occurred when translations of option lines were very long. Do not bother the translators with this detail. On a long option description, the translator continued on a new line as usual. gendoc.py created invalid rst syntax like this: -o, --option Description line 1 description line 2 The new output is: -o, --option Description line 1 description line 2 The lines could theoretically become very long, but line breaking is handled when generating the final documentation.

Takumi IINO - - Load All Authors

File last commit:

r19427:80983af3 default


                r20655:37f3be9d

default

Download file

             Makefile
        
                    47 lines
            
             | 1.2 KiB
            
                | text/x-makefile
            
             |
                MakefileLexer
            
             / doc / Makefile
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      SOURCES=$(notdir $(wildcard ../mercurial/help/*.[0-9].txt))

      MAN=$(SOURCES:%.txt=%)

      HTML=$(SOURCES:%.txt=%.html)

      GENDOC=gendoc.py ../mercurial/commands.py ../mercurial/help.py \

      	../mercurial/help/*.txt ../hgext/*.py ../hgext/*/__init__.py

      PREFIX=/usr/local

      MANDIR=$(PREFIX)/share/man

      INSTALL=install -c -m 644

      PYTHON=python

      RSTARGS=

      export HGENCODING=UTF-8

      all: man html

      man: $(MAN)

      html: $(HTML)

      common.txt $(SOURCES) $(SOURCES:%.txt=%.gendoc.txt): $(GENDOC)

      	${PYTHON} gendoc.py $(basename $@) > $@.tmp

      	mv $@.tmp $@

      %: %.txt %.gendoc.txt common.txt

      	$(PYTHON) runrst hgmanpage $(RSTARGS) --halt warning \

      	  --strip-elements-with-class htmlonly $*.txt $*

      %.html: %.txt %.gendoc.txt common.txt

      	$(PYTHON) runrst html $(RSTARGS) --halt warning \

      	  --link-stylesheet --stylesheet-path style.css $*.txt $*.html

      MANIFEST: man html

      # tracked files are already in the main MANIFEST

      	$(RM) $@

      	for i in $(MAN) $(HTML); do \

      	  echo "doc/$$i" >> $@ ; \

      	done

      install: man

      	for i in $(MAN) ; do \

      	  subdir=`echo $$i | sed -n 's/^.*\.\([0-9]\)$$/man\1/p'` ; \

      	  mkdir -p $(DESTDIR)$(MANDIR)/$$subdir ; \

      	  $(INSTALL) $$i $(DESTDIR)$(MANDIR)/$$subdir ; \

      	done

      clean:

      	$(RM) $(MAN) $(HTML) common.txt $(SOURCES) $(SOURCES:%.txt=%.gendoc.txt) MANIFEST

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

				SOURCES=$(notdir $(wildcard ../mercurial/help/*.[0-9].txt))
				MAN=$(SOURCES:%.txt=%)
				HTML=$(SOURCES:%.txt=%.html)
				GENDOC=gendoc.py ../mercurial/commands.py ../mercurial/help.py \
				../mercurial/help/.txt ../hgext/.py ../hgext/*/__init__.py
				PREFIX=/usr/local
				MANDIR=$(PREFIX)/share/man
				INSTALL=install -c -m 644
				PYTHON=python
				RSTARGS=

				export HGENCODING=UTF-8

				all: man html

				man: $(MAN)

				html: $(HTML)

				common.txt $(SOURCES) $(SOURCES:%.txt=%.gendoc.txt): $(GENDOC)
				${PYTHON} gendoc.py $(basename $@) > $@.tmp
				mv $@.tmp $@

				%: %.txt %.gendoc.txt common.txt
				$(PYTHON) runrst hgmanpage $(RSTARGS) --halt warning \
				--strip-elements-with-class htmlonly $.txt $

				%.html: %.txt %.gendoc.txt common.txt
				$(PYTHON) runrst html $(RSTARGS) --halt warning \
				--link-stylesheet --stylesheet-path style.css $.txt $.html

				MANIFEST: man html
				# tracked files are already in the main MANIFEST
				$(RM) $@
				for i in $(MAN) $(HTML); do \
				echo "doc/$$i" >> $@ ; \
				done

				install: man
				for i in $(MAN) ; do \
				subdir=`echo $$i \| sed -n 's/^.*\.\([0-9]\)$$/man\1/p'` ; \
				mkdir -p $(DESTDIR)$(MANDIR)/$$subdir ; \
				$(INSTALL) $$i $(DESTDIR)$(MANDIR)/$$subdir ; \
				done

				clean:
				$(RM) $(MAN) $(HTML) common.txt $(SOURCES) $(SOURCES:%.txt=%.gendoc.txt) MANIFEST