Download as
Browse Code »

Commit f7aa2bc2f189ee523828e625fe2e1ad222051bc9

Authored by Antonio Terceiro
Committed by Sergio Oliveira
1 parent e027d93b
Exists in master and in 67 other branches 3.x, add_you_are_here_breadcrumbs_label, api_for_colab, backup, backup_not_prod, button_suspension_points_remove, cdtc_configuration, create_institution_bootstrap_modal, design_validation, dev-lappis, dev_env_minimal, disable_email_dev, docs, fix_edit_institution, fix_edit_software_with_another_license, fix_list_style_inside_article, fix_members_pagination, fix_models_translations, fix_no_license, fix_software_api, fix_software_block_migration, fix_validations_and_tests, focus_search_field_theme, gov-user-refactoring, gov-user-refactoring-rails4, header_fix, institution_modal_on_rating, kalibro-conf-refactoring, kalibro-processor-package, lxc, mailinglist_page_title, margin_fix, mezuro_cookbook, organization_rating_style_changes, performance, prezento, r3, refactor_software_communities, refactor_software_for_sisp, register_page, release-process, release-process-v2, remove-unused-images, remove_backup_emails, remove_secondary_email_from_user, removing_super_archives_email, review_message, scope2method, signals_user_noosfero, sisp_colab_config, sisp_dev, sisp_dev_master, sisp_simple_version, software_as_organization, software_catalog_style_fix, software_catalog_style_fixes, spb_minimal_env, spec_refactor, stable-4.x, stable-devel, support_docs, syslog, temp_soft_comm_refactoring, thread_dropdown, thread_page, update_software_api, update_softwares_boxes

architecture: placeholder image

Showing 4 changed files with 49 additions and 29 deletions   Show diff stats
docs/.gitignore 0 → 100644
  Diff comments   View file @f7aa2bc
@@ -0,0 +1 @@ @@ -0,0 +1 @@
  1 +architecture.png
@@ -46,136 +46,135 @@ help: @@ -46,136 +46,135 @@ help:
46 @echo " linkcheck to check all external links for integrity" 46 @echo " linkcheck to check all external links for integrity"
47 @echo " doctest to run all doctests embedded in the documentation (if enabled)" 47 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
48 48
  49 +include local.mk
  50 +
49 clean: 51 clean:
50 rm -rf $(BUILDDIR)/* 52 rm -rf $(BUILDDIR)/*
51 - rm -f dns.rst  
52 -  
53 -dns.rst: ../test/dns_test.sh  
54 - (cd .. && sh test/dns_test.sh --doc) > $@ 53 + rm -rf $(CLEAN_FILES)
55 54
56 -html: dns.rst 55 +html: $(BUILT)
57 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html 56 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
58 @echo 57 @echo
59 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." 58 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
60 59
61 -dirhtml: dns.rst 60 +dirhtml: $(BUILT)
62 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml 61 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
63 @echo 62 @echo
64 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." 63 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
65 64
66 -singlehtml: dns.rst 65 +singlehtml: $(BUILT)
67 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml 66 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
68 @echo 67 @echo
69 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." 68 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
70 69
71 -pickle: dns.rst 70 +pickle: $(BUILT)
72 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle 71 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
73 @echo 72 @echo
74 @echo "Build finished; now you can process the pickle files." 73 @echo "Build finished; now you can process the pickle files."
75 74
76 -json: dns.rst 75 +json: $(BUILT)
77 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json 76 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
78 @echo 77 @echo
79 @echo "Build finished; now you can process the JSON files." 78 @echo "Build finished; now you can process the JSON files."
80 79
81 -htmlhelp: dns.rst 80 +htmlhelp: $(BUILT)
82 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp 81 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
83 @echo 82 @echo
84 @echo "Build finished; now you can run HTML Help Workshop with the" \ 83 @echo "Build finished; now you can run HTML Help Workshop with the" \
85 ".hhp project file in $(BUILDDIR)/htmlhelp." 84 ".hhp project file in $(BUILDDIR)/htmlhelp."
86 85
87 -qthelp: dns.rst 86 +qthelp: $(BUILT)
88 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp 87 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
89 @echo 88 @echo
90 @echo "Build finished; now you can run "qcollectiongenerator" with the" \ 89 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
91 - ".qhcp project file in $(BUILDDIR)/qthelp, like this: dns.rst" 90 + ".qhcp project file in $(BUILDDIR)/qthelp, like this: $(BUILT)"
92 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/softwarepublico.qhcp" 91 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/softwarepublico.qhcp"
93 - @echo "To view the help file: dns.rst" 92 + @echo "To view the help file: $(BUILT)"
94 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/softwarepublico.qhc" 93 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/softwarepublico.qhc"
95 94
96 -devhelp: dns.rst 95 +devhelp: $(BUILT)
97 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp 96 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
98 @echo 97 @echo
99 @echo "Build finished." 98 @echo "Build finished."
100 - @echo "To view the help file: dns.rst" 99 + @echo "To view the help file: $(BUILT)"
101 @echo "# mkdir -p $$HOME/.local/share/devhelp/softwarepublico" 100 @echo "# mkdir -p $$HOME/.local/share/devhelp/softwarepublico"
102 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/softwarepublico" 101 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/softwarepublico"
103 @echo "# devhelp" 102 @echo "# devhelp"
104 103
105 -epub: dns.rst 104 +epub: $(BUILT)
106 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub 105 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
107 @echo 106 @echo
108 @echo "Build finished. The epub file is in $(BUILDDIR)/epub." 107 @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
109 108
110 -latex: dns.rst 109 +latex: $(BUILT)
111 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 110 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
112 @echo 111 @echo
113 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." 112 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
114 @echo "Run \`make' in that directory to run these through (pdf)latex" \ 113 @echo "Run \`make' in that directory to run these through (pdf)latex" \
115 "(use \`make latexpdf' here to do that automatically)." 114 "(use \`make latexpdf' here to do that automatically)."
116 115
117 -latexpdf: dns.rst 116 +latexpdf: $(BUILT)
118 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 117 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
119 @echo "Running LaTeX files through pdflatex..." 118 @echo "Running LaTeX files through pdflatex..."
120 $(MAKE) -C $(BUILDDIR)/latex all-pdf 119 $(MAKE) -C $(BUILDDIR)/latex all-pdf
121 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." 120 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
122 121
123 -latexpdfja: dns.rst 122 +latexpdfja: $(BUILT)
124 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 123 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
125 @echo "Running LaTeX files through platex and dvipdfmx..." 124 @echo "Running LaTeX files through platex and dvipdfmx..."
126 $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja 125 $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
127 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." 126 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
128 127
129 -text: dns.rst 128 +text: $(BUILT)
130 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text 129 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
131 @echo 130 @echo
132 @echo "Build finished. The text files are in $(BUILDDIR)/text." 131 @echo "Build finished. The text files are in $(BUILDDIR)/text."
133 132
134 -man: dns.rst 133 +man: $(BUILT)
135 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man 134 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
136 @echo 135 @echo
137 @echo "Build finished. The manual pages are in $(BUILDDIR)/man." 136 @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
138 137
139 -texinfo: dns.rst 138 +texinfo: $(BUILT)
140 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo 139 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
141 @echo 140 @echo
142 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." 141 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
143 @echo "Run \`make' in that directory to run these through makeinfo" \ 142 @echo "Run \`make' in that directory to run these through makeinfo" \
144 "(use \`make info' here to do that automatically)." 143 "(use \`make info' here to do that automatically)."
145 144
146 -info: dns.rst 145 +info: $(BUILT)
147 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo 146 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
148 @echo "Running Texinfo files through makeinfo..." 147 @echo "Running Texinfo files through makeinfo..."
149 make -C $(BUILDDIR)/texinfo info 148 make -C $(BUILDDIR)/texinfo info
150 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." 149 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
151 150
152 -gettext: dns.rst 151 +gettext: $(BUILT)
153 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale 152 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
154 @echo 153 @echo
155 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." 154 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
156 155
157 -changes: dns.rst 156 +changes: $(BUILT)
158 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes 157 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
159 @echo 158 @echo
160 @echo "The overview file is in $(BUILDDIR)/changes." 159 @echo "The overview file is in $(BUILDDIR)/changes."
161 160
162 -linkcheck: dns.rst 161 +linkcheck: $(BUILT)
163 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck 162 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
164 @echo 163 @echo
165 @echo "Link check complete; look for any errors in the above output " \ 164 @echo "Link check complete; look for any errors in the above output " \
166 "or in $(BUILDDIR)/linkcheck/output.txt." 165 "or in $(BUILDDIR)/linkcheck/output.txt."
167 166
168 -doctest: dns.rst 167 +doctest: $(BUILT)
169 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest 168 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
170 @echo "Testing of doctests in the sources finished, look at the " \ 169 @echo "Testing of doctests in the sources finished, look at the " \
171 "results in $(BUILDDIR)/doctest/output.txt." 170 "results in $(BUILDDIR)/doctest/output.txt."
172 171
173 -xml: dns.rst 172 +xml: $(BUILT)
174 $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml 173 $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
175 @echo 174 @echo
176 @echo "Build finished. The XML files are in $(BUILDDIR)/xml." 175 @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
177 176
178 -pseudoxml: dns.rst 177 +pseudoxml: $(BUILT)
179 $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml 178 $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
180 @echo 179 @echo
181 @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." 180 @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
docs/arquitetura.rst
  Diff comments   View file @f7aa2bc
1 Arquitetura 1 Arquitetura
2 =========== 2 ===========
  3 +
  4 +A figura a seguir representa a arquitetura do SPB.
  5 +
  6 +.. TODO incluir uma figura feita manualmente, a gente deve ter isso de
  7 +.. apresentações anterires
  8 +.. image:: architecture.png
docs/local.mk 0 → 100644
  Diff comments   View file @f7aa2bc
@@ -0,0 +1,14 @@ @@ -0,0 +1,14 @@
  1 +# autogenerated DNS documentation
  2 +
  3 +BUILT += dns.rst
  4 +
  5 +dns.rst: ../test/dns_test.sh
  6 + (cd .. && sh test/dns_test.sh --doc) > $@
  7 +
  8 +BUILT += architecture.png
  9 +
  10 +architecture.png: architecture.dot
  11 + dot -Tpng -o $@ $<
  12 +
  13 +
  14 +CLEAN_FILES += $(BUILT)