Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Soma dois números.

Project description

Build Status Build Status Documentation Status codecov

simples

O pacote simples contém a seguinte estrutura

    simples/
        ├── setup.py
        |── simples/
        |       |──── __init__.py
        |       └──── soma.py
        |── tests/
        |      |──── __init__.py
        |      └──── test_soma.py
        └── docs/

Criando a pasta docs e construindo o html:

Pré requisitos:

  • sphinx-build para construir a documentação

A pasta docs e seu conteúdo pode ser criada usando os seguintes comandos:

foo@bar:~/simples$ mkdir docs
foo@bar:~/simples$ cd docs
foo@bar:~/simples/docs$ sphinx-quickstart
foo@bar:~/simples/docs$ sphinx-apidoc -f -o source/ ../simples

Dentro da pasta vários arquivos são criados, sendo alguns deles conf.py e index.rst.

Modificando o conf.py

  • O pacote simples utiliza o padrão de docstring do numpy. Então deverá ser inserida essa informação na lista extensões que se encontra dentro do arquivo.
extensions = ['sphinx.ext.autodoc',
            'sphinx.ext.napoleon'
]

Para saber mais sobre docstrings você pode consultar alguns desses tutoriais em português: caderno de laboratorio e python help.

  • Os módulos (tests e simples) se encontram fora da pasta docs, então para eles serem reconhecidos é necessário especificar a sua localização.
import os
import sys
sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, os.path.abspath('../simples'))
sys.path.insert(0, os.path.abspath('../tests'))
  • Para usar o template do read the docs é necessário realizar a instalação do tema e por fim alterar a variável html_theme.

No terminal:

foo@bar:~/ pip install sphinx_rtd_theme

No arquivo conf.py

html_theme = 'sphinx_rtd_theme'

Modificando o index.rst

No arquivo index.rst adicionar a seguinte linha source/modules

    .. toctree::
    :maxdepth: 2
    :caption: Contents:

    source/modules

Por fim, para construir o html da sua documentação, execute o terminal o comando make html

foo@bar:~/simples/docs$ make html

O html será gerado dentro do caminho ~/simples/docs/_build/html. Você poderá visualizar a aplicação em http://localhost:8000/, realizando os seguintes comandos.

foo@bar:~/simples/docs$ cd _build/html
foo@bar:~/simples/docs/_build/html$ python -m http.server
Serving HTTP on 0.0.0.0 port 8000 (http://0.0.0.0:8000/) ...

Referências

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for simples, version 0.1.0a0
Filename, size File type Python version Upload date Hashes
Filename, size simples-0.1.0a0-py3-none-any.whl (4.6 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size simples-0.1.0a0.tar.gz (3.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page