Project

General

Profile

« Previous | Next » 

Revision 7521

Added by ben leinfelder over 11 years ago

enable plantuml generation when building the sphinx documentation. note that you do need to have graphviz installed, but hopefully that is all.

View differences:

docs/tools/plantuml.conf
1 
skinparam activityFontColor black
2 
skinparam activityFontSize 10
3 
skinparam activityFontName arial
4 
skinparam activityArrowFontColor black
5 
skinparam activityArrowFontSize 10
6 
skinparam activityArrowFontName arial
7 
skinparam classArrowFontColor black
8 
skinparam classArrowFontSize 10
9 
skinparam classArrowFontName arial
10 
skinparam classAttributeFontColor black
11 
skinparam classAttributeFontSize 10
12 
skinparam classAttributeFontName arial
13 
skinparam classFontColor black
14 
skinparam classFontSize 10
15 
skinparam classFontName arial
16 
skinparam componentFontColor black
17 
skinparam componentFontSize 10
18 
skinparam componentFontName arial
19 
skinparam componentArrowFontColor black
20 
skinparam componentArrowFontSize 10
21 
skinparam componentArrowFontName arial
22 
skinparam noteFontColor black
23 
skinparam noteFontSize 10
24 
skinparam noteFontName arial
25 
skinparam packageFontColor black
26 
skinparam packageFontSize 10
27 
skinparam packageFontName arial
28 
skinparam sequenceActorFontColor black
29 
skinparam sequenceActorFontSize 10
30 
skinparam sequenceActorFontName arial
31 
skinparam sequenceArrowFontColor black
32 
skinparam sequenceArrowFontSize 10
33 
skinparam sequenceArrowFontName arial
34 
skinparam sequenceGroupingFontColor black
35 
skinparam sequenceGroupingFontSize 10
36 
skinparam sequenceGroupingFontName arial
37 
skinparam sequenceGroupingHeaderFontColor black
38 
skinparam sequenceGroupingHeaderFontSize 10
39 
skinparam sequenceGroupingHeaderFontName arial
40 
skinparam sequenceParticipantFontColor black
41 
skinparam sequenceParticipantFontSize 10
42 
skinparam sequenceParticipantFontName arial
43 
skinparam sequenceTitleFontColor black
44 
skinparam sequenceTitleFontSize 10
45 
skinparam sequenceTitleFontName arial
46 
skinparam titleFontColor black
47 
skinparam titleFontSize 10
48 
skinparam titleFontName arial
49 
skinparam usecaseFontColor black
50 
skinparam usecaseFontSize 7
51 
skinparam usecaseFontName arial
52 
skinparam usecaseActorFontColor black
53 
skinparam usecaseActorFontSize 7
54 
skinparam usecaseActorFontName arial
55 
skinparam usecaseArrowFontColor black
56 
skinparam usecaseArrowFontSize 7
57 
skinparam usecaseArrowFontName arial
0 58 

  		












  

    
      docs/user/metacat/source/query-index.rst
    
  





  
  1
  
    
.. raw:: latex


  		




  
  2
  
    

  		




  
  3
  
    
  \newpage


  		




  
  4
  
    

  		




  
  5
  
    

  		




  1
  6
  
    
Metacat Indexing


  		




  2
  7
  
    
===========================


  		




  3
  8
  
    
Lorem ipsum


  		




  ......




  57
  62
  
    
Step-by-step instructions


  		




  58
  63
  
    

  		




  59
  64
  
    
NOTE: this may take a long time depending on the size of your Metacat store.


  		




  
  65
  
    

  		




  
  66
  
    

  		




  
  67
  
    

  		




  
  68
  
    
Class design overview


  		




  
  69
  
    
----------------------


  		




  
  70
  
    

  		




  
  71
  
    
.. figure:: images/indexing-class-diagram.png


  		




  
  72
  
    

  		




  
  73
  
    
   Figure 1. Class design overview.


  		




  
  74
  
    
   


  		




  
  75
  
    
..


  		




  
  76
  
    
  @startuml images/indexing-class-diagram.png


  		




  
  77
  
    
  


  		




  
  78
  
    
	package index {


  		




  
  79
  
    
		  


  		




  
  80
  
    
		class FieldSpec {


  		




  
  81
  
    
			- String name


  		




  
  82
  
    
			+ abstract String[] extract(Reader s);


  		




  
  83
  
    
		}


  		




  
  84
  
    
		


  		




  
  85
  
    
		class D1IndexField {


  		




  
  86
  
    
		}


  		




  
  87
  
    
		


  		




  
  88
  
    
		class XpathIndexField {


  		




  
  89
  
    
			- String xpath


  		




  
  90
  
    
		}


  		




  
  91
  
    
		    


  		




  
  92
  
    
	}


  		




  
  93
  
    
	


  		




  
  94
  
    
	FieldSpec <|-- D1IndexField


  		




  
  95
  
    
	FieldSpec <|-- XpathIndexField


  		




  
  96
  
    
	


  		




  
  97
  
    
  


  		




  
  98
  
    
  @enduml


  		












  

    
      docs/user/metacat/Makefile
    
  





  7
  7
  
    
PAPER         =


  		




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


  		




  9
  9
  
    
GRAPHVIZ      = `which dot`


  		




  
  10
  
    
JAVA          = `which java`


  		




  
  11
  
    
PLANTUMLCONF  = $(CURDIR)/../../tools/plantuml.conf


  		




  
  12
  
    
PLANTUML      = $(JAVA) -jar "$(CURDIR)/../../tools/plantuml.jar" -config "$(PLANTUMLCONF)"


  		




  10
  13
  
    

  		




  11
  14
  
    
# Internal variables.


  		




  12
  15
  
    
PAPEROPT_a4     = -D latex_paper_size=a4


  		




  ......




  33
  36
  
    
	-rm -rf $(BUILDDIR)/*


  		




  34
  37
  
    

  		




  35
  38
  
    
plantuml:


  		




  36
  
  
    
	GRAPHVIZ_DOT=$(GRAPHVIZ) plantuml source 


  		




  
  39
  
    
	GRAPHVIZ_DOT=$(GRAPHVIZ) $(PLANTUML) "$(CURDIR)/source/*.rst"


  		




  37
  40
  
    

  		




  38
  41
  
    
html: 


  		




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


  		












  

    
      build.xml
    
  





  1353
  1353
  
    
		     And you must also have the 'make' build tool installed


  		




  1354
  1354
  
    
		-->


  		




  1355
  1355
  
    
		<exec dir="${docdir}/user/metacat" executable="make"> 


  		




  
  1356
  
    
		        <arg value="plantuml"/> 


  		




  
  1357
  
    
		</exec>


  		




  
  1358
  
    
		


  		




  
  1359
  
    
		<exec dir="${docdir}/user/metacat" executable="make"> 


  		




  1356
  1360
  
    
		        <arg value="html"/> 


  		




  1357
  1361
  
    
		</exec>


  		




  
  1362
  
    
		


  		




  1358
  1363
  
    
    </target>


  		




  1359
  1364
  
    

  		




  1360
  1365
  
    
	<target name="javadoc" depends="prepare"


  		












Also available in:  Unified diff