forked from cakephp/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2dda113
commit ef6ff0e
Showing
7 changed files
with
243 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,132 @@ | ||
# Makefile for Sphinx documentation | ||
# | ||
|
||
# You can set these variables from the command line. | ||
SPHINXOPTS = | ||
SPHINXBUILD = sphinx-build | ||
PAPER = | ||
BUILDDIR = ../build | ||
PYTHON = python | ||
LANG = pt | ||
|
||
# Internal variables. | ||
PAPEROPT_a4 = -D latex_paper_size=a4 | ||
PAPEROPT_letter = -D latex_paper_size=letter | ||
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees/$(LANG) $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . | ||
|
||
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest | ||
|
||
help: | ||
@echo "Please use \`make <target>' where <target> is one of" | ||
@echo " html to make standalone HTML files" | ||
@echo " dirhtml to make HTML files named index.html in directories" | ||
@echo " singlehtml to make a single large HTML file" | ||
@echo " pickle to make pickle files" | ||
@echo " json to make JSON files" | ||
@echo " htmlhelp to make HTML files and a HTML help project" | ||
@echo " qthelp to make HTML files and a qthelp project" | ||
@echo " devhelp to make HTML files and a Devhelp project" | ||
@echo " epub to make an epub" | ||
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" | ||
@echo " latexpdf to make LaTeX files and run them through pdflatex" | ||
@echo " text to make text files" | ||
@echo " man to make manual pages" | ||
@echo " changes to make an overview of all changed/added/deprecated items" | ||
@echo " linkcheck to check all external links for integrity" | ||
@echo " doctest to run all doctests embedded in the documentation (if enabled)" | ||
|
||
clean: | ||
-rm -rf $(BUILDDIR)/* | ||
|
||
html: | ||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html/$(LANG) | ||
@echo | ||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html/$(LANG)." | ||
|
||
dirhtml: | ||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml | ||
@echo | ||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." | ||
|
||
singlehtml: | ||
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml | ||
@echo | ||
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." | ||
|
||
pickle: | ||
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle | ||
@echo | ||
@echo "Build finished; now you can process the pickle files." | ||
|
||
json: | ||
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json | ||
@echo | ||
@echo "Build finished; now you can process the JSON files." | ||
|
||
htmlhelp: | ||
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp/$(LANG) | ||
@echo | ||
@echo "Build finished; now you can run HTML Help Workshop with the" \ | ||
".hhp project file in $(BUILDDIR)/htmlhelp/$(LANG)." | ||
|
||
qthelp: | ||
$(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:" | ||
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/CakePHPCookbook.qhcp" | ||
@echo "To view the help file:" | ||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/CakePHPCookbook.qhc" | ||
|
||
devhelp: | ||
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp | ||
@echo | ||
@echo "Build finished." | ||
@echo "To view the help file:" | ||
@echo "# mkdir -p $$HOME/.local/share/devhelp/CakePHPCookbook" | ||
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/CakePHPCookbook" | ||
@echo "# devhelp" | ||
|
||
epub: | ||
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub/$(LANG) | ||
@echo | ||
@echo "Build finished. The epub file is in $(BUILDDIR)/epub/$(LANG)." | ||
|
||
latex: | ||
$(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: | ||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex/$(LANG) | ||
@echo "Running LaTeX files through pdflatex..." | ||
make -C $(BUILDDIR)/latex/$(LANG) all-pdf | ||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex/$(LANG)." | ||
|
||
text: | ||
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text | ||
@echo | ||
@echo "Build finished. The text files are in $(BUILDDIR)/text." | ||
|
||
man: | ||
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man | ||
@echo | ||
@echo "Build finished. The manual pages are in $(BUILDDIR)/man." | ||
|
||
changes: | ||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes | ||
@echo | ||
@echo "The overview file is in $(BUILDDIR)/changes." | ||
|
||
linkcheck: | ||
$(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: | ||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest | ||
@echo "Testing of doctests in the sources finished, look at the " \ | ||
"results in $(BUILDDIR)/doctest/output.txt." |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# -*- coding: utf-8 -*- | ||
# | ||
# CakePHP Cookbook documentation build configuration file, created by | ||
# sphinx-quickstart on Tue Jan 18 12:54:14 2011. | ||
# | ||
# This file is execfile()d with the current directory set to its containing dir. | ||
# | ||
# Note that not all possible configuration values are present in this | ||
# autogenerated file. | ||
# | ||
# All configuration values have a default; values that are commented out | ||
# serve to show the default. | ||
|
||
import sys, os | ||
|
||
# Append the top level directory of the docs, so we can import from the config dir. | ||
sys.path.insert(0, os.path.abspath('..')) | ||
|
||
# Pull in all the configuration options defined in the global config file.. | ||
from config.all import * | ||
|
||
language = 'pt' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
Contents | ||
######## | ||
|
||
.. toctree:: | ||
|
||
.. todolist:: | ||
|
||
|
||
Indices and tables | ||
================== | ||
|
||
* :ref:`genindex` | ||
* :ref:`modindex` | ||
* :ref:`search` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
.. CakePHP Cookbook documentation master file, created by | ||
sphinx-quickstart on Tue Jan 18 12:54:14 2011. | ||
You can adapt this file completely to your liking, but it should at least | ||
contain the root `toctree` directive. | ||
O Manual | ||
######## | ||
|
||
Bem vindo ao `Cookbook`, a documentação do CakePHP. O `Cookbook` é um sistema | ||
como um wiki, que permite que o público faça suas contribuições. Com um sistema | ||
aberto, esperamos manter um elevado nível de qualidade, validade, e precisão | ||
para a documentação do CakePHP. O CakePHP também torna mais fácil para que | ||
qualquer pessoal possa contribuir. | ||
|
||
Um ***enorme*** obrigado a `AD7six <http://www.ad7six.com/>`_, que defendeu o | ||
Cookbook, colocando intermináveis horas de desenvolvimento, testes e melhorando | ||
esta aplicação. | ||
|
||
Como Você Pode Ajudar | ||
===================== | ||
|
||
Se você perceber algum erro, algo que está incompleta, algo que não foi coberto | ||
ou alguma coisa que não esteja te agradando, aqui está como você pode ajudar: | ||
|
||
#. Clique no link editar da seção que pretende alterar. | ||
#. Acesse o `Cookbook`, se solicitado use a sua conta do | ||
#. Log in to `Cookbook` if prompted using your `Bakery <http://bakery.cakephp.org>`_. | ||
Qualquer pessoa pode ter uma conta do `bakery`. | ||
#. Por favor, leia as `diretrizes para submeter ao Cookbook <http://docs.cakephp.org/view/482/contributing-to-the-cookbook>`_ | ||
para garantir a consistência. | ||
#. Envie as adições/edições para revisão usando HTML válido e semântico. | ||
#. Acompanhe o progresso de suas submissões usando o Feed RSS ou volte no dia | ||
seguinte para ver as alterações aprovadas. | ||
|
||
Traduções | ||
========= | ||
|
||
Envie um email para a equipe de documentação (docs at cakephp dot org) ou vá até | ||
o canal do IRC (#cakephp on freenode) para discutir os esforços de tradução que | ||
você gostaria de participar. | ||
|
||
Dicas de tradução: | ||
|
||
- Navegue e edite no idioma em que você deseja que o conteúdo seja traduzido, de | ||
outro modo você não vai ver o que já foi traduzido. | ||
- Sinta-se livre para ir com tudo se o idioma escolhido já existe no | ||
`Cookbook`. | ||
- Use a lista de tarefas (canto superior direito) para ver onde a atenção é | ||
necessária para seu idioma. | ||
- Use a `Linguagem Informal <http://en.wikipedia.org/wiki/Register_(linguistics)>`_. | ||
- Traduza o conteúdo e o títudo ao mesmo tempo. | ||
- Compare com o conteúdo em Inglês antes de submeter a correção (se você | ||
corrigir algo, mas não integrar com o `upstream` suas mudanças não seram | ||
aceitas). | ||
- Se você precisar escrever um termo em Inglês, coloque-o entre as tags ``<em>``. | ||
Por exemplo: "asdf asdf *Controller* asdf" ou "asdf asdf Controlador | ||
(*Controller*) asdf" conforme apropriado. | ||
- Não submeta traduções parciais. | ||
- Não edite seções com mudanças pendentes. | ||
- Não use `entidades html <http://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references>`_ | ||
para caracteres acentuados, o `Cookbook` utiliza UTF-8. | ||
- Não faça modificações significativas na marcação (HTML) ou adicione novos | ||
conteúdos. | ||
- Se no conteúdo original está faltando alguma informação, envie uma edição | ||
primeiro. | ||
|
||
Estamos empenhados para fazer a documentação do CakePHP melhor do que nunca. | ||
Esperamos que você se junte a nós, usando o `Cookbook` e retribuindo a um | ||
projeto que nos tem beneficiado tanto. |