aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--.gitignore1
-rw-r--r--.gitmodules3
-rw-r--r--Makefile158
-rw-r--r--README.md124
-rw-r--r--README.rst182
-rw-r--r--TODO.rst6
m---------_themes/sphinx_rtd_theme0
-rw-r--r--conf.py243
l---------index.rst1
9 files changed, 594 insertions, 124 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..e35d885
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+_build
diff --git a/.gitmodules b/.gitmodules
new file mode 100644
index 0000000..a4fdaab
--- /dev/null
+++ b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "_themes/sphinx_rtd_theme"]
+ path = _themes/sphinx_rtd_theme
+ url = https://github.com/snide/sphinx_rtd_theme
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..2cabf43
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,158 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+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 " texinfo to make Texinfo files"
+ @echo " info to make Texinfo files and run them through makeinfo"
+ @echo " gettext to make PO message catalogs"
+ @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
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+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
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+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/BoasPrticasemDesenvolvimento.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/BoasPrticasemDesenvolvimento.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/BoasPrticasemDesenvolvimento"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/BoasPrticasemDesenvolvimento"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+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
+ @echo "Running LaTeX files through pdflatex..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+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."
+
+texinfo:
+ $(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:
+ $(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:
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+ @echo
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+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."
+
+web: html
+
+web_deploy:
+ @rsync -avz --delete _build/html/ boaspraticas:/var/sites/boaspraticas/www/
diff --git a/README.md b/README.md
deleted file mode 100644
index b801f89..0000000
--- a/README.md
+++ /dev/null
@@ -1,124 +0,0 @@
-Boas Práticas em Desenvolvimento
-================================
-
-Ementa
-------
-
-* Título do curso: Boas Práticas em Desenvolvimento de Software.
-* Professores: Silvio Rhatto.
-* Tempo estimado de dedicação do aluno e agenda de comprometimento sugerida: 40 horas.
-* Público alvo e Pré-requisitos: o curso é orientado a desenvolvedores(as) de software que já possuem ao menos um conhecimento básico em programação e que necessitam melhorar sua produtividade ou mesmo trabalhar em time de maneira fluida.
-* Dificuldade do curso: intermediário.
-
-### Currículo do professor
-
-Silvio Rhatto é bacharel em meteorologia, técnico em eletrônica e autodidata em computação. Desenvolve software livre há mais de 10 anos e já realizou diversos cursos na área de tecnologia, especialmente em segurança da informação e privacidade.
-
-### Descrição do curso
-
-Este curso introduz diversas metedologias, ferramentas e conceitos de desenvolvimento de software que aumentam a produtividade e facilitam o compartilhamento de código. A ideia é preencher a lacuna dos cursos específicos de programação que dificilmente abordam questões práticas e cotidianas como controle de versão, manutenção de um ambiente de desenvolvimento, licenciamento, segurança, etc.
-
-Apesar dos softwares serem produtos definidos, reprodutíveis e na maioria das vezes determinísticos, o seu desenvolvimento implica na canalização da criatividade, na capacidade de trabalhar colaborativamente e enfrentar desafios como a integração de elementos já disponíveis. Para que isso seja possível e agradável, é fundamental que o(a) programador(a) entenda o processo de desenvolvimento que vai além de simplesmente codificar seu raciocínio numa linguagem de programação.
-
-Serão apresentados problemas essenciais e acidentais da programação e diferentes maneiras de abordá-los, indo desde a ansiedade de programar até os modernos ambientes de teste contínuo.
-
-Ao concluir o curso, o(a) aluno(a) terá condições de:
-
-* Analisar criticamente as técnicas e ferramentas apresentadas.
-* Escolher quais delas mais se adequam à sua realidade.
-* Pesquisar o tema por conta própria.
-
-### Estrutura do curso
-
-O curso será dividido em 8 aulas, sendo cada aula organizada nos seguintes capítulos:
-
-1. Metodologias e técnicas de produtividade.
-2. Ambientes de desenvolvimento eficientes.
-3. Licenças de software.
-4. Controle de versão e social coding.
-5. DevOps: desenvolvendo e orquestrando.
-6. Segurança e privacidade.
-7. Quando (não) reinventar a roda.
-8. Lidando com os clientes.
-
-Os capítulos serão organizados na forma de:
-
-* Vídeo aulas.
-* Testes e atividades online.
-* Exercícios individuais de aplicação.
-* Leitura de material didático de apoio.
-
-### Dificuldade do curso
-
-Intermediária.
-
-### Relação do curso com o PRONATEC
-
-Eixo Tecnológico: Informação e Comunicação (é um curso transversal, aderente á todos os demais cursos que envolvem linguagens de programação e / ou desenvolvimento de software).
-
-### Aplicação do conhecimento
-
-Como e onde ele vai usar usar isso ? Por que que ele será um profissional melhor aplicando este conhecimento ?
-
-### Material Didático
-
-Sugestão de Bibliografia:
-
-* O Mítico Homem-Mês.
-
-Plano de aulas
---------------
-
-1. Metodologias e técnicas de produtividade.
- * Apresentação do professor e do curso.
- * O que são boas práticas de desenvolvimento?
- * Mitos e verdades do desenvolvimento.
- * A catedral e o bazar: Lei de Linus.
- * Metodologias pessoais.
- * Pomodoro.
- * GTD.
- * ZTD.
- * Metodologias em equipe.
- * Agile.
- * Scrum.
-2. Ambientes de desenvolvimento eficientes.
- * A guerra dos editores de texto e IDEs.
- * Ambiente de desenvolvimento eficiente e confortável.
- * Backups e ferramentaria.
- * Criando seus templates de desenvolvimento.
- * Mantendo um diário de bordo e uma base de conhecimento.
-3. Licenças de software.
- * GPL.
- * BSD.
- * Apache.
- * Creative Commons.
- * Domínio Público.
-4. Controle de versão e social coding.
- * O que é? Pra que serve?
- * Quais sistemas existem?
- * Focando no git e no git-flow.
- * Versionando desde o dia 0.
- * Social coding (gitlab, github, etc).
-5. DevOps: desenvolvendo e orquestrando.
- * Vagrant, docker, KVM e afins.
- * Ambientes reprodutíveis.
- * Integração contínua usando o [Travis CI](http://travis-ci.org/).
- * Fazendo o deploy:
- * SSH e rsync.
- * Permissões.
-6. Segurança e privacidade.
- * Segurança começa no desenvolvimento.
- * Use bibliotecas consolidadass!
- * Princípio das permissões mínimas.
- * Criptografia básica:
- * Assinaturas digitais.
- * Comunicação cifrada.
- * Certificados x509 para SSL/TLS/HTTPS.
-7. Quando (não) reinventar a roda.
- * Antipatterns.
- * Inferno de dependências.
- * Documentação: lendo e escrevendo.
-8. Lidando com os clientes.
- * Como fazer / Apresentar uma proposta comercial para um cliente?
- * Items essenciais de uma proposta.
- * Como cobrar (por hora ou por projeto).
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..793c42a
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,182 @@
+.. Boas Práticas em Desenvolvimento documentation master file, created by
+ sphinx-quickstart on Sat Oct 31 19:44:44 2015.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Boas Práticas em Desenvolvimento
+================================
+
+Ementa
+------
+
+- Título do curso: Boas Práticas em Desenvolvimento de Software.
+- Professores: Silvio Rhatto.
+- Tempo estimado de dedicação do aluno e agenda de comprometimento
+ sugerida: 40 horas.
+- Público alvo e Pré-requisitos: o curso é orientado a
+ desenvolvedores(as) de software que já possuem ao menos um
+ conhecimento básico em programação e que necessitam melhorar sua
+ produtividade ou mesmo trabalhar em time de maneira fluida.
+- Dificuldade do curso: intermediário.
+
+Currículo do professor
+~~~~~~~~~~~~~~~~~~~~~~
+
+Silvio Rhatto é bacharel em meteorologia, técnico em eletrônica e
+autodidata em computação. Desenvolve software livre há mais de 10 anos e
+já realizou diversos cursos na área de tecnologia, especialmente em
+segurança da informação e privacidade.
+
+Descrição do curso
+~~~~~~~~~~~~~~~~~~
+
+Este curso introduz diversas metedologias, ferramentas e conceitos de
+desenvolvimento de software que aumentam a produtividade e facilitam o
+compartilhamento de código. A ideia é preencher a lacuna dos cursos
+específicos de programação que dificilmente abordam questões práticas e
+cotidianas como controle de versão, manutenção de um ambiente de
+desenvolvimento, licenciamento, segurança, etc.
+
+Apesar dos softwares serem produtos definidos, reprodutíveis e na
+maioria das vezes determinísticos, o seu desenvolvimento implica na
+canalização da criatividade, na capacidade de trabalhar
+colaborativamente e enfrentar desafios como a integração de elementos já
+disponíveis. Para que isso seja possível e agradável, é fundamental que
+o(a) programador(a) entenda o processo de desenvolvimento que vai além
+de simplesmente codificar seu raciocínio numa linguagem de programação.
+
+Serão apresentados problemas essenciais e acidentais da programação e
+diferentes maneiras de abordá-los, indo desde a ansiedade de programar
+até os modernos ambientes de teste contínuo.
+
+Ao concluir o curso, o(a) aluno(a) terá condições de:
+
+- Analisar criticamente as técnicas e ferramentas apresentadas.
+- Escolher quais delas mais se adequam à sua realidade.
+- Pesquisar o tema por conta própria.
+
+Estrutura do curso
+~~~~~~~~~~~~~~~~~~
+
+O curso será dividido em 8 aulas, sendo cada aula organizada nos
+seguintes capítulos:
+
+1. Metodologias e técnicas de produtividade.
+2. Ambientes de desenvolvimento eficientes.
+3. Licenças de software.
+4. Controle de versão e social coding.
+5. DevOps: desenvolvendo e orquestrando.
+6. Segurança e privacidade.
+7. Quando (não) reinventar a roda.
+8. Lidando com os clientes.
+
+Os capítulos serão organizados na forma de:
+
+- Vídeo aulas.
+- Testes e atividades online.
+- Exercícios individuais de aplicação.
+- Leitura de material didático de apoio.
+
+Dificuldade do curso
+~~~~~~~~~~~~~~~~~~~~
+
+Intermediária.
+
+Relação do curso com o PRONATEC
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Eixo Tecnológico: Informação e Comunicação (é um curso transversal,
+aderente á todos os demais cursos que envolvem linguagens de programação
+e / ou desenvolvimento de software).
+
+Aplicação do conhecimento
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Como e onde ele vai usar usar isso ? Por que que ele será um
+profissional melhor aplicando este conhecimento ?
+
+Material Didático
+~~~~~~~~~~~~~~~~~
+
+Sugestão de Bibliografia:
+
+- O Mítico Homem-Mês.
+
+Plano de aulas
+--------------
+
+1. Metodologias e técnicas de produtividade.
+
+- Apresentação do professor e do curso.
+- O que são boas práticas de desenvolvimento?
+- Mitos e verdades do desenvolvimento.
+- A catedral e o bazar: Lei de Linus.
+- Metodologias pessoais.
+
+ - Pomodoro.
+ - GTD.
+ - ZTD.
+
+- Metodologias em equipe.
+
+ - Agile.
+ - Scrum.
+
+2. Ambientes de desenvolvimento eficientes.
+
+- A guerra dos editores de texto e IDEs.
+- Ambiente de desenvolvimento eficiente e confortável.
+- Backups e ferramentaria.
+- Criando seus templates de desenvolvimento.
+- Mantendo um diário de bordo e uma base de conhecimento.
+
+3. Licenças de software.
+
+- GPL.
+- BSD.
+- Apache.
+- Creative Commons.
+- Domínio Público.
+
+4. Controle de versão e social coding.
+
+- O que é? Pra que serve?
+- Quais sistemas existem?
+- Focando no git e no git-flow.
+- Versionando desde o dia 0.
+- Social coding (gitlab, github, etc).
+
+5. DevOps: desenvolvendo e orquestrando.
+
+- Vagrant, docker, KVM e afins.
+- Ambientes reprodutíveis.
+- Integração contínua usando o `Travis CI <http://travis-ci.org/>`_.
+- Fazendo o deploy:
+
+ - SSH e rsync.
+ - Permissões.
+
+6. Segurança e privacidade.
+
+- Segurança começa no desenvolvimento.
+- Use bibliotecas consolidadass!
+- Princípio das permissões mínimas.
+- Criptografia básica:
+
+ - Assinaturas digitais.
+ - Comunicação cifrada.
+
+- Certificados x509 para SSL/TLS/HTTPS.
+
+7. Quando (não) reinventar a roda.
+
+- Antipatterns.
+- Inferno de dependências.
+- Documentação: lendo e escrevendo.
+
+8. Lidando com os clientes.
+
+- Como fazer / Apresentar uma proposta comercial para um cliente?
+- Items essenciais de uma proposta.
+- Como cobrar (por hora ou por projeto).
+
diff --git a/TODO.rst b/TODO.rst
new file mode 100644
index 0000000..e37260c
--- /dev/null
+++ b/TODO.rst
@@ -0,0 +1,6 @@
+TODO
+====
+
+- Migrar para `sphinx <http://sphinx-doc.org/>`_.
+- Gerar saídas em HTML e pdf.
+
diff --git a/_themes/sphinx_rtd_theme b/_themes/sphinx_rtd_theme
new file mode 160000
+Subproject 012d42db6a2b00f799223963fb8b0aa3754630e
diff --git a/conf.py b/conf.py
new file mode 100644
index 0000000..4980f9c
--- /dev/null
+++ b/conf.py
@@ -0,0 +1,243 @@
+# -*- coding: utf-8 -*-
+#
+# Boas Práticas em Desenvolvimento documentation build configuration file, created by
+# sphinx-quickstart on Sat Oct 31 19:44:44 2015.
+#
+# 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
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Boas Práticas em Desenvolvimento'
+copyright = u'2015, Silvio Rhatto'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+html_theme = "sphinx_rtd_theme"
+html_theme_path = ["_themes/sphinx_rtd_theme", ]
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'BoasPrticasemDesenvolvimentodoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+ ('index', 'BoasPrticasemDesenvolvimento.tex', u'Boas Práticas em Desenvolvimento Documentation',
+ u'Silvio Rhatto', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ ('index', 'boasprticasemdesenvolvimento', u'Boas Práticas em Desenvolvimento Documentation',
+ [u'Silvio Rhatto'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ ('index', 'BoasPrticasemDesenvolvimento', u'Boas Práticas em Desenvolvimento Documentation',
+ u'Silvio Rhatto', 'BoasPrticasemDesenvolvimento', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
diff --git a/index.rst b/index.rst
new file mode 120000
index 0000000..92cacd2
--- /dev/null
+++ b/index.rst
@@ -0,0 +1 @@
+README.rst \ No newline at end of file