Um template para começar o desenvolvimento de apps
Project description
Gerar Documentação
- Instale sphinx
pip install sphinx
- Crie e entre na pasta docs e rode sphinx-quickstart
mkdir docs
cd docs
sphinx-quickstart
- Preencha as informações
> Separar os diretórios de origem e compilação (y/n) [n]: y
> Nome do projeto: Template de Python
> Nome(s) de autor(es): A. U. Thor
> Lançamento do projeto []: 2022-12-31
> Idioma do projeto [en]: en
Após isso, teremos duas pastas dentro de docs. A pasta source vai ser onde vamos trabalhar para gerar documentação. A pasta build será onde a documentação estará.
- Editar o endereço do seus modulos (no template, é a pasta src) em relação ao arquivo
docs/source/conf.py
. No nosso caso, será:
import os
import sys
sys.path.insert(0, os.path.abspath("../../src"))
- Adicione extensões. No arquivo
docs/source/conf.py
, onde está
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = []
Substitua por:
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.intersphinx",
"sphinx.ext.autodoc",
"sphinx.ext.mathjax",
"sphinx.ext.viewcode",
"sphinx.ext.napoleon",
]
- Altere o thema html do arquivo
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "sphinx_rtd_theme"
- Adicione logo, favicon e estilos css à sua página. Para isso, adicione todos os arquivos dentro de
docs/source/_static
. Dentro do arquivodocs/source/conf.py
, adicione as seguintes linhas:
# 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"]
html_logo = "_static/logo.png"
html_css_files = ["custom-theme.css"]
html_favicon = "_static/favicon.ico"
html_theme_options = {
"logo_only": True,
"display_version": False,
}
- Dentro da pasta docs, rode:
make html
A documentação estará em docs/build/html
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for emdemor_app_template-0.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5ac8fdb9acabfa5daf549a4fd168da196c65c577d633670ca8cf879817a8f0b7 |
|
MD5 | 6622eba62146c30ded701d05d75dcc37 |
|
BLAKE2b-256 | cd055f0eff931024c06e3a9d8ce68075b9511b5ccf77781d9aead90175a32f9f |
Close
Hashes for emdemor_app_template-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bab3aa7adae1bedb65cff26365cd87112b5b232fb36cef8b8d0538d264afb9d9 |
|
MD5 | 5259a0e48e292d585fcd26d173747403 |
|
BLAKE2b-256 | 814dcba68df8575bbf8d1554e530618ec11aa1ffe2c1ab2e3620a53867a7f77e |