Download as
Browse Code »

Commit dee504c4d05705e74474c78ace5ab975522d5911

Authored by Antonio Terceiro
Committed by Sergio Oliveira
1 parent 484e08a2
Exists in master and in 65 other branches 3.x, add_you_are_here_breadcrumbs_label, api_for_colab, backup, backup_not_prod, cdtc_configuration, create_institution_bootstrap_modal, design_validation, dev-lappis, dev_env_minimal, disable_email_dev, docs, fix_edit_software_permission, fix_edit_software_with_another_license, fix_hover_button_whitening, fix_members_pagination, fix_models_translations, 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, 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_community_noosfero, sisp_colab_config, sisp_dev, sisp_dev_master, sisp_improvements, 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

Include DNS information in the documentation

Showing 3 changed files with 31 additions and 25 deletions   Show diff stats
@@ -4,6 +4,7 @@ @@ -4,6 +4,7 @@
4 /.tmp 4 /.tmp
5 /tmp 5 /tmp
6 /docs/_build 6 /docs/_build
  7 +/docs/dns.rst
7 /.*.html 8 /.*.html
8 /local.rake 9 /local.rake
9 *.swp 10 *.swp
@@ -48,130 +48,134 @@ help: @@ -48,130 +48,134 @@ help:
48 48
49 clean: 49 clean:
50 rm -rf $(BUILDDIR)/* 50 rm -rf $(BUILDDIR)/*
  51 + rm -f dns.rst
51 52
52 -html: 53 +dns.rst: ../test/dns_test.sh
  54 + (cd .. && sh test/dns_test.sh --doc) | pandoc -f markdown --to rst --output $@
  55 +
  56 +html: dns.rst
53 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html 57 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
54 @echo 58 @echo
55 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." 59 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
56 60
57 -dirhtml: 61 +dirhtml: dns.rst
58 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml 62 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
59 @echo 63 @echo
60 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." 64 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
61 65
62 -singlehtml: 66 +singlehtml: dns.rst
63 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml 67 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
64 @echo 68 @echo
65 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." 69 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
66 70
67 -pickle: 71 +pickle: dns.rst
68 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle 72 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
69 @echo 73 @echo
70 @echo "Build finished; now you can process the pickle files." 74 @echo "Build finished; now you can process the pickle files."
71 75
72 -json: 76 +json: dns.rst
73 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json 77 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
74 @echo 78 @echo
75 @echo "Build finished; now you can process the JSON files." 79 @echo "Build finished; now you can process the JSON files."
76 80
77 -htmlhelp: 81 +htmlhelp: dns.rst
78 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp 82 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
79 @echo 83 @echo
80 @echo "Build finished; now you can run HTML Help Workshop with the" \ 84 @echo "Build finished; now you can run HTML Help Workshop with the" \
81 ".hhp project file in $(BUILDDIR)/htmlhelp." 85 ".hhp project file in $(BUILDDIR)/htmlhelp."
82 86
83 -qthelp: 87 +qthelp: dns.rst
84 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp 88 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
85 @echo 89 @echo
86 @echo "Build finished; now you can run "qcollectiongenerator" with the" \ 90 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
87 - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" 91 + ".qhcp project file in $(BUILDDIR)/qthelp, like this: dns.rst"
88 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/softwarepublico.qhcp" 92 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/softwarepublico.qhcp"
89 - @echo "To view the help file:" 93 + @echo "To view the help file: dns.rst"
90 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/softwarepublico.qhc" 94 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/softwarepublico.qhc"
91 95
92 -devhelp: 96 +devhelp: dns.rst
93 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp 97 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
94 @echo 98 @echo
95 @echo "Build finished." 99 @echo "Build finished."
96 - @echo "To view the help file:" 100 + @echo "To view the help file: dns.rst"
97 @echo "# mkdir -p $$HOME/.local/share/devhelp/softwarepublico" 101 @echo "# mkdir -p $$HOME/.local/share/devhelp/softwarepublico"
98 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/softwarepublico" 102 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/softwarepublico"
99 @echo "# devhelp" 103 @echo "# devhelp"
100 104
101 -epub: 105 +epub: dns.rst
102 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub 106 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
103 @echo 107 @echo
104 @echo "Build finished. The epub file is in $(BUILDDIR)/epub." 108 @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
105 109
106 -latex: 110 +latex: dns.rst
107 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 111 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
108 @echo 112 @echo
109 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." 113 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
110 @echo "Run \`make' in that directory to run these through (pdf)latex" \ 114 @echo "Run \`make' in that directory to run these through (pdf)latex" \
111 "(use \`make latexpdf' here to do that automatically)." 115 "(use \`make latexpdf' here to do that automatically)."
112 116
113 -latexpdf: 117 +latexpdf: dns.rst
114 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 118 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
115 @echo "Running LaTeX files through pdflatex..." 119 @echo "Running LaTeX files through pdflatex..."
116 $(MAKE) -C $(BUILDDIR)/latex all-pdf 120 $(MAKE) -C $(BUILDDIR)/latex all-pdf
117 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." 121 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
118 122
119 -latexpdfja: 123 +latexpdfja: dns.rst
120 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 124 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
121 @echo "Running LaTeX files through platex and dvipdfmx..." 125 @echo "Running LaTeX files through platex and dvipdfmx..."
122 $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja 126 $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
123 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." 127 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
124 128
125 -text: 129 +text: dns.rst
126 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text 130 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
127 @echo 131 @echo
128 @echo "Build finished. The text files are in $(BUILDDIR)/text." 132 @echo "Build finished. The text files are in $(BUILDDIR)/text."
129 133
130 -man: 134 +man: dns.rst
131 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man 135 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
132 @echo 136 @echo
133 @echo "Build finished. The manual pages are in $(BUILDDIR)/man." 137 @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
134 138
135 -texinfo: 139 +texinfo: dns.rst
136 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo 140 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
137 @echo 141 @echo
138 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." 142 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
139 @echo "Run \`make' in that directory to run these through makeinfo" \ 143 @echo "Run \`make' in that directory to run these through makeinfo" \
140 "(use \`make info' here to do that automatically)." 144 "(use \`make info' here to do that automatically)."
141 145
142 -info: 146 +info: dns.rst
143 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo 147 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
144 @echo "Running Texinfo files through makeinfo..." 148 @echo "Running Texinfo files through makeinfo..."
145 make -C $(BUILDDIR)/texinfo info 149 make -C $(BUILDDIR)/texinfo info
146 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." 150 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
147 151
148 -gettext: 152 +gettext: dns.rst
149 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale 153 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
150 @echo 154 @echo
151 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." 155 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
152 156
153 -changes: 157 +changes: dns.rst
154 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes 158 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
155 @echo 159 @echo
156 @echo "The overview file is in $(BUILDDIR)/changes." 160 @echo "The overview file is in $(BUILDDIR)/changes."
157 161
158 -linkcheck: 162 +linkcheck: dns.rst
159 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck 163 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
160 @echo 164 @echo
161 @echo "Link check complete; look for any errors in the above output " \ 165 @echo "Link check complete; look for any errors in the above output " \
162 "or in $(BUILDDIR)/linkcheck/output.txt." 166 "or in $(BUILDDIR)/linkcheck/output.txt."
163 167
164 -doctest: 168 +doctest: dns.rst
165 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest 169 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
166 @echo "Testing of doctests in the sources finished, look at the " \ 170 @echo "Testing of doctests in the sources finished, look at the " \
167 "results in $(BUILDDIR)/doctest/output.txt." 171 "results in $(BUILDDIR)/doctest/output.txt."
168 172
169 -xml: 173 +xml: dns.rst
170 $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml 174 $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
171 @echo 175 @echo
172 @echo "Build finished. The XML files are in $(BUILDDIR)/xml." 176 @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
173 177
174 -pseudoxml: 178 +pseudoxml: dns.rst
175 $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml 179 $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
176 @echo 180 @echo
177 @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." 181 @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
docs/index.rst
  Diff comments   View file @dee504c
@@ -37,3 +37,4 @@ Conteúdos @@ -37,3 +37,4 @@ Conteúdos
37 37
38 install 38 install
39 dependencies 39 dependencies
  40 + dns