Implement make targets: man, html, docs.
This commit is contained in:
		
					parent
					
						
							
								76563756ee
							
						
					
				
			
			
				commit
				
					
						4dac520d98
					
				
			
		
					 3 changed files with 21 additions and 15 deletions
				
			
		
							
								
								
									
										11
									
								
								Makefile
									
										
									
									
									
								
							
							
						
						
									
										11
									
								
								Makefile
									
										
									
									
									
								
							| 
						 | 
				
			
			@ -63,13 +63,13 @@ $(DOCSREF): $(DOCSREFSH)
 | 
			
		|||
	$(DOCSREFSH)
 | 
			
		||||
 | 
			
		||||
# Manpages #3: generic part
 | 
			
		||||
sphinxman: $(MANTYPES) $(DOCSREF) $(PYTHON_VERSION)
 | 
			
		||||
man: $(MANTYPES) $(DOCSREF) $(PYTHON_VERSION)
 | 
			
		||||
	$(SPHINXM)
 | 
			
		||||
 | 
			
		||||
sphinxhtml: $(MANTYPES) $(DOCSREF) $(PYTHON_VERSION)
 | 
			
		||||
html: $(MANTYPES) $(DOCSREF) $(PYTHON_VERSION)
 | 
			
		||||
	$(SPHINXH)
 | 
			
		||||
 | 
			
		||||
docs: sphinxman sphinxhtml
 | 
			
		||||
docs: man html
 | 
			
		||||
 | 
			
		||||
# Manpages #5: release part
 | 
			
		||||
MANWEBDIR=$(WEBBASE)/man/$(CHANGELOG_VERSION)
 | 
			
		||||
| 
						 | 
				
			
			@ -102,12 +102,9 @@ $(DOTMAN7DSTDIR)/cdist-type%.rst: $(DOTTYPEDIR)/%/man.rst
 | 
			
		|||
	ln -sf "$^" $@
 | 
			
		||||
 | 
			
		||||
# Manpages #3: generic part
 | 
			
		||||
dotsphinxman: $(DOTMANTYPES)
 | 
			
		||||
dotman: $(DOTMANTYPES)
 | 
			
		||||
	$(SPHINXM)
 | 
			
		||||
 | 
			
		||||
dotman: dotsphinxman
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
################################################################################
 | 
			
		||||
# Speeches
 | 
			
		||||
#
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -93,6 +93,19 @@ other directory and add it to MANPATH.
 | 
			
		|||
 | 
			
		||||
Full HTML documentation can be accessed at docs/dist/html/index.html.
 | 
			
		||||
 | 
			
		||||
You can also build only man pages or only html documentation, for
 | 
			
		||||
only man pages run:
 | 
			
		||||
 | 
			
		||||
.. code-block:: sh
 | 
			
		||||
 | 
			
		||||
    make man
 | 
			
		||||
 | 
			
		||||
for only html documentation run:
 | 
			
		||||
 | 
			
		||||
.. code-block:: sh
 | 
			
		||||
 | 
			
		||||
    make html
 | 
			
		||||
 | 
			
		||||
You can also build man pages for types in your ~/.cdist directory:
 | 
			
		||||
 | 
			
		||||
.. code-block:: sh
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -56,10 +56,6 @@ CONFIG
 | 
			
		|||
------
 | 
			
		||||
Configure one or more hosts
 | 
			
		||||
 | 
			
		||||
.. option:: -h, --help
 | 
			
		||||
 | 
			
		||||
    Show the help screen
 | 
			
		||||
 | 
			
		||||
.. option:: -c CONF_DIR, --conf-dir CONF_DIR
 | 
			
		||||
 | 
			
		||||
    Add a configuration directory. Can be specified multiple times.
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue