This release is a pre-release and may not be stable for production use.
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-buildpara 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
simplesutiliza o padrão de docstring do numpy. Então deverá ser inserida essa informação na listaextensõesque 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
Metadata
Release files for simples 0.1.0a0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| simples-0.1.0a0.tar.gz | 3.3 kB | Without provenance | Details for simples-0.1.0a0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| simples-0.1.0a0-py3-none-any.whl | Python 3 | none | any | Details for simples-0.1.0a0-py3-none-any.whl |
Total release size: 7.9 kB
Release files / simples-0.1.0a0.tar.gz
| Download URL | simples-0.1.0a0.tar.gz |
|---|---|
| Size | 3.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
103cf4618802d9d5675c8fd145aa63a603a67f2b77f16122f284df354cd5aa7f
|
|
BLAKE2b-256 checksum How to use checksums |
884f4fc56cd73800d0fb4a9263ab317d742598134fefd0e8ddbc20eb0375a8f7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3
|
Release files / simples-0.1.0a0-py3-none-any.whl
| Download URL | simples-0.1.0a0-py3-none-any.whl |
|---|---|
| Size | 4.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e86057df5e596679d99cdb6fe922ec02e8ee39bc076b7b1a01c59853c7f627e5
|
|
BLAKE2b-256 checksum How to use checksums |
c06d3ffb2daf03ae34dbdcbb2f62753f0db5c371df08210d5ab263a0444a6883
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3
|
Security for simples 0.1.0a0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.