diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..6e48c0f --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +architecture.png diff --git a/docs/Makefile b/docs/Makefile index dd24fc4..9a2b394 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -46,136 +46,135 @@ help: @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" +include local.mk + clean: rm -rf $(BUILDDIR)/* - rm -f dns.rst - -dns.rst: ../test/dns_test.sh - (cd .. && sh test/dns_test.sh --doc) > $@ + rm -rf $(CLEAN_FILES) -html: dns.rst +html: $(BUILT) $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." -dirhtml: dns.rst +dirhtml: $(BUILT) $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." -singlehtml: dns.rst +singlehtml: $(BUILT) $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml @echo @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." -pickle: dns.rst +pickle: $(BUILT) $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle @echo @echo "Build finished; now you can process the pickle files." -json: dns.rst +json: $(BUILT) $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json @echo @echo "Build finished; now you can process the JSON files." -htmlhelp: dns.rst +htmlhelp: $(BUILT) $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ ".hhp project file in $(BUILDDIR)/htmlhelp." -qthelp: dns.rst +qthelp: $(BUILT) $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this: dns.rst" + ".qhcp project file in $(BUILDDIR)/qthelp, like this: $(BUILT)" @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/softwarepublico.qhcp" - @echo "To view the help file: dns.rst" + @echo "To view the help file: $(BUILT)" @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/softwarepublico.qhc" -devhelp: dns.rst +devhelp: $(BUILT) $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp @echo @echo "Build finished." - @echo "To view the help file: dns.rst" + @echo "To view the help file: $(BUILT)" @echo "# mkdir -p $$HOME/.local/share/devhelp/softwarepublico" @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/softwarepublico" @echo "# devhelp" -epub: dns.rst +epub: $(BUILT) $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub @echo @echo "Build finished. The epub file is in $(BUILDDIR)/epub." -latex: dns.rst +latex: $(BUILT) $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." @echo "Run \`make' in that directory to run these through (pdf)latex" \ "(use \`make latexpdf' here to do that automatically)." -latexpdf: dns.rst +latexpdf: $(BUILT) $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through pdflatex..." $(MAKE) -C $(BUILDDIR)/latex all-pdf @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." -latexpdfja: dns.rst +latexpdfja: $(BUILT) $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through platex and dvipdfmx..." $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." -text: dns.rst +text: $(BUILT) $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text @echo @echo "Build finished. The text files are in $(BUILDDIR)/text." -man: dns.rst +man: $(BUILT) $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man @echo @echo "Build finished. The manual pages are in $(BUILDDIR)/man." -texinfo: dns.rst +texinfo: $(BUILT) $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." @echo "Run \`make' in that directory to run these through makeinfo" \ "(use \`make info' here to do that automatically)." -info: dns.rst +info: $(BUILT) $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo "Running Texinfo files through makeinfo..." make -C $(BUILDDIR)/texinfo info @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." -gettext: dns.rst +gettext: $(BUILT) $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale @echo @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." -changes: dns.rst +changes: $(BUILT) $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes @echo @echo "The overview file is in $(BUILDDIR)/changes." -linkcheck: dns.rst +linkcheck: $(BUILT) $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck @echo @echo "Link check complete; look for any errors in the above output " \ "or in $(BUILDDIR)/linkcheck/output.txt." -doctest: dns.rst +doctest: $(BUILT) $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest @echo "Testing of doctests in the sources finished, look at the " \ "results in $(BUILDDIR)/doctest/output.txt." -xml: dns.rst +xml: $(BUILT) $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml @echo @echo "Build finished. The XML files are in $(BUILDDIR)/xml." -pseudoxml: dns.rst +pseudoxml: $(BUILT) $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml @echo @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/arquitetura.rst b/docs/arquitetura.rst index 62f0138..7aa7d35 100644 --- a/docs/arquitetura.rst +++ b/docs/arquitetura.rst @@ -1,2 +1,8 @@ Arquitetura =========== + +A figura a seguir representa a arquitetura do SPB. + +.. TODO incluir uma figura feita manualmente, a gente deve ter isso de +.. apresentações anterires +.. image:: architecture.png diff --git a/docs/local.mk b/docs/local.mk new file mode 100644 index 0000000..35ae473 --- /dev/null +++ b/docs/local.mk @@ -0,0 +1,14 @@ +# autogenerated DNS documentation + +BUILT += dns.rst + +dns.rst: ../test/dns_test.sh + (cd .. && sh test/dns_test.sh --doc) > $@ + +BUILT += architecture.png + +architecture.png: architecture.dot + dot -Tpng -o $@ $< + + +CLEAN_FILES += $(BUILT) -- libgit2 0.21.2