docs/man -> docs/src and update Makefile and build-helper.
This commit is contained in:
		
					parent
					
						
							
								b04ab0b630
							
						
					
				
			
			
				commit
				
					
						0d64d6a5b6
					
				
			
		
					 30 changed files with 28 additions and 31 deletions
				
			
		
							
								
								
									
										13
									
								
								.gitignore
									
										
									
									
										vendored
									
									
								
							
							
						
						
									
										13
									
								
								.gitignore
									
										
									
									
										vendored
									
									
								
							| 
						 | 
					@ -2,14 +2,11 @@
 | 
				
			||||||
.*.swp
 | 
					.*.swp
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# Ignore generated manpages
 | 
					# Ignore generated manpages
 | 
				
			||||||
docs/man/.marker
 | 
					docs/src/.marker
 | 
				
			||||||
docs/man/man1/*.1
 | 
					docs/src/man1/*.1
 | 
				
			||||||
docs/man/man7/*.7
 | 
					docs/src/man7/*.7
 | 
				
			||||||
docs/man/man*/*.html
 | 
					docs/src/man7/cdist-type__*.rst
 | 
				
			||||||
docs/man/man*/*.xml
 | 
					docs/src/cdist-reference.rst
 | 
				
			||||||
docs/man/man*/docbook-xsl.css
 | 
					 | 
				
			||||||
docs/man/man7/cdist-type__*.rst
 | 
					 | 
				
			||||||
docs/man/cdist-reference.rst
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
# Ignore cdist cache for version control
 | 
					# Ignore cdist cache for version control
 | 
				
			||||||
/cache/
 | 
					/cache/
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
							
								
								
									
										38
									
								
								Makefile
									
										
									
									
									
								
							
							
						
						
									
										38
									
								
								Makefile
									
										
									
									
									
								
							| 
						 | 
					@ -20,7 +20,7 @@
 | 
				
			||||||
 | 
					
 | 
				
			||||||
helper=./bin/build-helper
 | 
					helper=./bin/build-helper
 | 
				
			||||||
 | 
					
 | 
				
			||||||
MANDIR=docs/man
 | 
					DOCS_SRC_DIR=docs/src
 | 
				
			||||||
SPEECHDIR=docs/speeches
 | 
					SPEECHDIR=docs/speeches
 | 
				
			||||||
TYPEDIR=cdist/conf/type
 | 
					TYPEDIR=cdist/conf/type
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					@ -36,13 +36,13 @@ CHANGELOG_FILE=docs/changelog
 | 
				
			||||||
 | 
					
 | 
				
			||||||
PYTHON_VERSION=cdist/version.py
 | 
					PYTHON_VERSION=cdist/version.py
 | 
				
			||||||
 | 
					
 | 
				
			||||||
SPHINXM=make -C $(MANDIR) man
 | 
					SPHINXM=make -C $(DOCS_SRC_DIR) man
 | 
				
			||||||
SPHINXH=make -C $(MANDIR) html
 | 
					SPHINXH=make -C $(DOCS_SRC_DIR) html
 | 
				
			||||||
################################################################################
 | 
					################################################################################
 | 
				
			||||||
# Manpages
 | 
					# Manpages
 | 
				
			||||||
#
 | 
					#
 | 
				
			||||||
MAN1DSTDIR=$(MANDIR)/man1
 | 
					MAN1DSTDIR=$(DOCS_SRC_DIR)/man1
 | 
				
			||||||
MAN7DSTDIR=$(MANDIR)/man7
 | 
					MAN7DSTDIR=$(DOCS_SRC_DIR)/man7
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# Manpages #1: Types
 | 
					# Manpages #1: Types
 | 
				
			||||||
# Use shell / ls to get complete list - $(TYPEDIR)/*/man.rst does not work
 | 
					# Use shell / ls to get complete list - $(TYPEDIR)/*/man.rst does not work
 | 
				
			||||||
| 
						 | 
					@ -56,26 +56,26 @@ $(MAN7DSTDIR)/cdist-type%.rst: $(TYPEDIR)/%/man.rst
 | 
				
			||||||
	ln -sf "../../../$^" $@
 | 
						ln -sf "../../../$^" $@
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# Manpages #2: reference
 | 
					# Manpages #2: reference
 | 
				
			||||||
MANREF=$(MAN7DSTDIR)/cdist-reference.rst
 | 
					DOCSREF=$(MAN7DSTDIR)/cdist-reference.rst
 | 
				
			||||||
MANREFSH=$(MANDIR)/cdist-reference.rst.sh
 | 
					DOCSREFSH=$(DOCS_SRC_DIR)/cdist-reference.rst.sh
 | 
				
			||||||
 | 
					
 | 
				
			||||||
$(MANREF): $(MANREFSH)
 | 
					$(DOCSREF): $(DOCSREFSH)
 | 
				
			||||||
	$(MANREFSH)
 | 
						$(DOCSREFSH)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# Manpages #3: generic part
 | 
					# Manpages #3: generic part
 | 
				
			||||||
mansphinxman: $(MANTYPES) $(MANREF) $(PYTHON_VERSION)
 | 
					sphinxman: $(MANTYPES) $(DOCSREF) $(PYTHON_VERSION)
 | 
				
			||||||
	$(SPHINXM)
 | 
						$(SPHINXM)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
mansphinxhtml: $(MANTYPES) $(MANREF) $(PYTHON_VERSION)
 | 
					sphinxhtml: $(MANTYPES) $(DOCSREF) $(PYTHON_VERSION)
 | 
				
			||||||
	$(SPHINXH)
 | 
						$(SPHINXH)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
man: mansphinxman mansphinxhtml
 | 
					docs: sphinxman sphinxhtml
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# Manpages #5: release part
 | 
					# Manpages #5: release part
 | 
				
			||||||
MANWEBDIR=$(WEBBASE)/man/$(CHANGELOG_VERSION)
 | 
					MANWEBDIR=$(WEBBASE)/man/$(CHANGELOG_VERSION)
 | 
				
			||||||
MANBUILDDIR=docs/dist/html
 | 
					MANBUILDDIR=docs/dist/html
 | 
				
			||||||
 | 
					
 | 
				
			||||||
man-dist: man
 | 
					docs-dist: man
 | 
				
			||||||
	rm -rf "${MANWEBDIR}"
 | 
						rm -rf "${MANWEBDIR}"
 | 
				
			||||||
	mkdir -p "${MANWEBDIR}"
 | 
						mkdir -p "${MANWEBDIR}"
 | 
				
			||||||
	# mkdir -p "${MANWEBDIR}/man1" "${MANWEBDIR}/man7"
 | 
						# mkdir -p "${MANWEBDIR}/man1" "${MANWEBDIR}/man7"
 | 
				
			||||||
| 
						 | 
					@ -102,10 +102,10 @@ $(DOTMAN7DSTDIR)/cdist-type%.rst: $(DOTTYPEDIR)/%/man.rst
 | 
				
			||||||
	ln -sf "$^" $@
 | 
						ln -sf "$^" $@
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# Manpages #3: generic part
 | 
					# Manpages #3: generic part
 | 
				
			||||||
dotmansphinxman: $(DOTMANTYPES)
 | 
					dotsphinxman: $(DOTMANTYPES)
 | 
				
			||||||
	$(SPHINXM)
 | 
						$(SPHINXM)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
dotman: dotmansphinxman
 | 
					dotman: dotsphinxman
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
################################################################################
 | 
					################################################################################
 | 
				
			||||||
| 
						 | 
					@ -147,7 +147,7 @@ web-doc:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
web-dist: web-blog web-doc
 | 
					web-dist: web-blog web-doc
 | 
				
			||||||
 | 
					
 | 
				
			||||||
web-pub: web-dist man-dist speeches-dist
 | 
					web-pub: web-dist docs-dist speeches-dist
 | 
				
			||||||
	cd "${WEBDIR}" && make pub
 | 
						cd "${WEBDIR}" && make pub
 | 
				
			||||||
 | 
					
 | 
				
			||||||
web-release-all: man-latest-link
 | 
					web-release-all: man-latest-link
 | 
				
			||||||
| 
						 | 
					@ -212,12 +212,12 @@ release:
 | 
				
			||||||
#
 | 
					#
 | 
				
			||||||
 | 
					
 | 
				
			||||||
clean:
 | 
					clean:
 | 
				
			||||||
	rm -f $(MANDIR)/cdist-reference.rst
 | 
						rm -f $(DOCS_SRC_DIR)/cdist-reference.rst
 | 
				
			||||||
 | 
					
 | 
				
			||||||
	find "$(MANDIR)" -mindepth 2 -type l \
 | 
						find "$(DOCS_SRC_DIR)" -mindepth 2 -type l \
 | 
				
			||||||
	| xargs rm -f
 | 
						| xargs rm -f
 | 
				
			||||||
 | 
					
 | 
				
			||||||
	make -C $(MANDIR) clean
 | 
						make -C $(DOCS_SRC_DIR) clean
 | 
				
			||||||
 | 
					
 | 
				
			||||||
	find * -name __pycache__  | xargs rm -rf
 | 
						find * -name __pycache__  | xargs rm -rf
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -206,8 +206,8 @@ eof
 | 
				
			||||||
        "$0" check-date
 | 
					        "$0" check-date
 | 
				
			||||||
        "$0" check-unittest
 | 
					        "$0" check-unittest
 | 
				
			||||||
 | 
					
 | 
				
			||||||
        # Generate man pages (indirect check if they build)
 | 
					        # Generate documentation (man and html)
 | 
				
			||||||
        make man
 | 
					        make docs
 | 
				
			||||||
 | 
					
 | 
				
			||||||
        # Generate speeches (indirect check if they build)
 | 
					        # Generate speeches (indirect check if they build)
 | 
				
			||||||
        make speeches
 | 
					        make speeches
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -241,8 +241,8 @@ eof
 | 
				
			||||||
        "$0" check-date
 | 
					        "$0" check-date
 | 
				
			||||||
        "$0" check-unittest
 | 
					        "$0" check-unittest
 | 
				
			||||||
 | 
					
 | 
				
			||||||
        # Generate man pages (indirect check if they build)
 | 
					        # Generate documentation (man and html)
 | 
				
			||||||
        make helper=${helper} WEBDIR=${WEBDIR} man
 | 
					        make helper=${helper} WEBDIR=${WEBDIR} docs
 | 
				
			||||||
 | 
					
 | 
				
			||||||
        # Generate speeches (indirect check if they build)
 | 
					        # Generate speeches (indirect check if they build)
 | 
				
			||||||
        make helper=${helper} WEBDIR=${WEBDIR} speeches
 | 
					        make helper=${helper} WEBDIR=${WEBDIR} speeches
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
		 Before Width: | Height: | Size: 1.5 KiB After Width: | Height: | Size: 1.5 KiB  | 
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue