Project

General

Profile

« Previous | Next » 

Revision 6899

Added by Matt Jones over 12 years ago

Modifications to make the build more readily find locally installed versions of
sphinx-build, and to remove the unneccary 'html' directory; output of
admindoc is now written directly into build/docs.

View differences:

docs/user/metacat/source/development.rst
8 8 

  		




  9
  9
  
    
Detailed `API documentation`_ for Metacat is available with the release.


  		




  10
  10
  
    

  		




  11
  
  
    
.. _API documentation: ../api/index.html


  		




  
  11
  
    
.. _API documentation: ./api/index.html


  		




  12
  12
  
    

  		




  13
  13
  
    
Contents:


  		




  14
  14
  
    

  		












  

    
      docs/user/metacat/source/index.rst
    
  





  36
  36
  
    

  		




  37
  37
  
    
.. _Administrators Guide: http://knb.ecoinformatics.org/software/metacat/MetacatAdministratorGuide.pdf


  		




  38
  38
  
    

  		




  39
  
  
    
.. _API documentation: ../api/index.html


  		




  
  39
  
    
.. _API documentation: ./api/index.html


  		




  40
  40
  
    

  		




  41
  41
  
    
.. _metacat-bin-2.0.0.tar.gz: http://knb.ecoinformatics.org/software/dist/metacat-bin-2.0.0.tar.gz


  		




  42
  42
  
    

  		












  

    
      docs/user/metacat/Makefile
    
  





  3
  3
  
    

  		




  4
  4
  
    
# You can set these variables from the command line.


  		




  5
  5
  
    
SPHINXOPTS    =


  		




  6
  
  
    
SPHINXBUILD   = sphinx-build


  		




  
  6
  
    
SPHINXBUILD   = `which sphinx-build`


  		




  7
  7
  
    
PAPER         =


  		




  8
  8
  
    
BUILDDIR      = ../../../build/docs


  		




  9
  
  
    
GRAPHVIZ      = /opt/local/bin/dot


  		




  
  9
  
    
GRAPHVIZ      = `which dot`


  		




  10
  10
  
    

  		




  11
  11
  
    
# Internal variables.


  		




  12
  12
  
    
PAPEROPT_a4     = -D latex_paper_size=a4


  		




  ......




  36
  36
  
    
	GRAPHVIZ_DOT=$(GRAPHVIZ) plantuml source 


  		




  37
  37
  
    

  		




  38
  38
  
    
html: 


  		




  39
  
  
    
	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html


  		




  
  39
  
    
	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)


  		




  40
  40
  
    
	@echo


  		




  41
  
  
    
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."


  		




  
  41
  
    
	@echo "Build finished. The HTML pages are in $(BUILDDIR)."


  		




  42
  42
  
    

  		




  43
  43
  
    
dirhtml:


  		




  44
  44
  
    
	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml


  		












Also available in:  Unified diff