Download as
Browse Code »

Commit f7aa2bc2f189ee523828e625fe2e1ad222051bc9

Authored by Antonio Terceiro
Committed by Sergio Oliveira
1 parent e027d93b
Exists in master and in 90 other branches 3.x, add_sisp_to_chef, add_super_archives_plugin, api_for_colab, automates_core_packing, backup, backup_not_prod, cdtc_configuration, changes_in_buttons_on_content_panel, colab_automated_login, colab_spb_plugin_recipe, colab_widgets_settings, design_validation, dev-lappis, dev_env_minimal, disable_email_dev, docs, fix_breadcrumbs_position, fix_categories_software_link, fix_edit_institution, fix_edit_software_with_another_license, fix_get_license_info, fix_gitlab_assets_permission, fix_list_style_inside_article, fix_list_style_on_folder_elements, fix_members_pagination, fix_merge_request_url, fix_models_translations, fix_no_license, fix_software_api, fix_software_block_migration, fix_software_communities_translations, fix_software_communities_unit_test, fix_style_create_institution_admin_panel, fix_superarchives_imports, fix_sym_links_noosfero, focus_search_field_theme, gov-user-refactoring, gov-user-refactoring-rails4, header_fix, institution_modal_on_rating, kalibro-conf-refactoring, kalibro-processor-package, lxc_settings, margin_fix, mezuro_cookbook, performance, prezento, r3, refactor_download_block, refactor_software_communities, refactor_software_for_sisp, register_page, release-process, release-process-v2, remove-unused-images, remove_backup_emails, remove_broken_theme, remove_secondary_email_from_user, remove_sisp_buttons, removing_super_archives_email, review_message, scope2method, signals_user_noosfero, sisp_catalog_header, sisp_colab_config, sisp_dev, sisp_dev_master, sisp_simple_version, software_as_organization, software_catalog_style_fix, software_communities_html_refactor, software_infos_api, spb_minimal_env, spb_to_rails4, spec_refactor, stable-4.1, stable-4.2, stable-4.x, stable-devel, support_docs, syslog, temp_soft_comm_refactoring, theme_header, theme_javascript_refactory, thread_dropdown, thread_page, update_search_by_categories, 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 @@
  1 +architecture.png
... ...
docs/Makefile
  Diff comments   View file @f7aa2bc
... ... @@ -46,136 +46,135 @@ help:
46 46 @echo " linkcheck to check all external links for integrity"
47 47 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
48 48  
  49 +include local.mk
  50 +
49 51 clean:
50 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 56 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
58 57 @echo
59 58 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
60 59  
61   -dirhtml: dns.rst
  60 +dirhtml: $(BUILT)
62 61 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
63 62 @echo
64 63 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
65 64  
66   -singlehtml: dns.rst
  65 +singlehtml: $(BUILT)
67 66 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
68 67 @echo
69 68 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
70 69  
71   -pickle: dns.rst
  70 +pickle: $(BUILT)
72 71 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
73 72 @echo
74 73 @echo "Build finished; now you can process the pickle files."
75 74  
76   -json: dns.rst
  75 +json: $(BUILT)
77 76 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
78 77 @echo
79 78 @echo "Build finished; now you can process the JSON files."
80 79  
81   -htmlhelp: dns.rst
  80 +htmlhelp: $(BUILT)
82 81 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
83 82 @echo
84 83 @echo "Build finished; now you can run HTML Help Workshop with the" \
85 84 ".hhp project file in $(BUILDDIR)/htmlhelp."
86 85  
87   -qthelp: dns.rst
  86 +qthelp: $(BUILT)
88 87 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
89 88 @echo
90 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 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 93 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/softwarepublico.qhc"
95 94  
96   -devhelp: dns.rst
  95 +devhelp: $(BUILT)
97 96 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
98 97 @echo
99 98 @echo "Build finished."
100   - @echo "To view the help file: dns.rst"
  99 + @echo "To view the help file: $(BUILT)"
101 100 @echo "# mkdir -p $$HOME/.local/share/devhelp/softwarepublico"
102 101 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/softwarepublico"
103 102 @echo "# devhelp"
104 103  
105   -epub: dns.rst
  104 +epub: $(BUILT)
106 105 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
107 106 @echo
108 107 @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
109 108  
110   -latex: dns.rst
  109 +latex: $(BUILT)
111 110 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
112 111 @echo
113 112 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
114 113 @echo "Run \`make' in that directory to run these through (pdf)latex" \
115 114 "(use \`make latexpdf' here to do that automatically)."
116 115  
117   -latexpdf: dns.rst
  116 +latexpdf: $(BUILT)
118 117 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
119 118 @echo "Running LaTeX files through pdflatex..."
120 119 $(MAKE) -C $(BUILDDIR)/latex all-pdf
121 120 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
122 121  
123   -latexpdfja: dns.rst
  122 +latexpdfja: $(BUILT)
124 123 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
125 124 @echo "Running LaTeX files through platex and dvipdfmx..."
126 125 $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
127 126 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
128 127  
129   -text: dns.rst
  128 +text: $(BUILT)
130 129 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
131 130 @echo
132 131 @echo "Build finished. The text files are in $(BUILDDIR)/text."
133 132  
134   -man: dns.rst
  133 +man: $(BUILT)
135 134 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
136 135 @echo
137 136 @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
138 137  
139   -texinfo: dns.rst
  138 +texinfo: $(BUILT)
140 139 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
141 140 @echo
142 141 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
143 142 @echo "Run \`make' in that directory to run these through makeinfo" \
144 143 "(use \`make info' here to do that automatically)."
145 144  
146   -info: dns.rst
  145 +info: $(BUILT)
147 146 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
148 147 @echo "Running Texinfo files through makeinfo..."
149 148 make -C $(BUILDDIR)/texinfo info
150 149 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
151 150  
152   -gettext: dns.rst
  151 +gettext: $(BUILT)
153 152 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
154 153 @echo
155 154 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
156 155  
157   -changes: dns.rst
  156 +changes: $(BUILT)
158 157 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
159 158 @echo
160 159 @echo "The overview file is in $(BUILDDIR)/changes."
161 160  
162   -linkcheck: dns.rst
  161 +linkcheck: $(BUILT)
163 162 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
164 163 @echo
165 164 @echo "Link check complete; look for any errors in the above output " \
166 165 "or in $(BUILDDIR)/linkcheck/output.txt."
167 166  
168   -doctest: dns.rst
  167 +doctest: $(BUILT)
169 168 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
170 169 @echo "Testing of doctests in the sources finished, look at the " \
171 170 "results in $(BUILDDIR)/doctest/output.txt."
172 171  
173   -xml: dns.rst
  172 +xml: $(BUILT)
174 173 $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
175 174 @echo
176 175 @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
177 176  
178   -pseudoxml: dns.rst
  177 +pseudoxml: $(BUILT)
179 178 $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
180 179 @echo
181 180 @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
... ...
docs/arquitetura.rst
  Diff comments   View file @f7aa2bc
1 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 @@
  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)
... ...