Skip to main content

Un generatore di documentazione Python-centrico con temi modulari

Project description

Zompi

PyPI Version PyPI Downloads License GitHub Repo

Un generatore di documentazione Python-centrico con temi modulari


Installa Zompi

Per installare Zompi, digita nel terminale:

pip install zompi

Crea una pagina di documentazione

Crea un file, ad esempio lorem_ipsum.py e scrivici:

from zompi.page import BasePage
import zompi.contrib

class Page(BasePage):
    PAGE_TITLE = "Lorem Ipsum"

    def __init__(self):
        return zompi.contrib.markdown('''## Testo 
Lorem ipsum dolor sit amet, consectetur adipisci elit, sed eiusmod tempor incidunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur. Quis aute iure reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint obcaecat cupiditat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.''')

    def __str__(self):
        return BasePage.page(zompi.contrib.DOC, 'Markdown')

Se ti stai chiedendo cosa significa zompi.contrib.DOC, quella constante si riferisce a quel documento, se si usa un'altra variabile, userá un altro documento.


Aggiungere un tema

Per aggiungere un tema, all'inizio di una pagina inserisci inserisci:

from modulotema import Theme
from zompi.theme import use

e nella classe della pagina (preferibilmente in __init__()) inserite:

use(Theme)

Ricorda che di defalut Zompi usa il tema Sonzi (ovvero zompi.theme.sonzi)


Altri pacchetti

Guarda anche DeWeb e utiilityes


Versioni nuove, supportate e EOL

Versione Stato Note
0.1.0 Nuova

Project details


Download files

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

Source Distribution

zompi-0.1.1.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

zompi-0.1.1-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

Details for the file zompi-0.1.1.tar.gz.

File metadata

  • Download URL: zompi-0.1.1.tar.gz
  • Upload date:
  • Size: 4.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for zompi-0.1.1.tar.gz
Algorithm Hash digest
SHA256 23667936185c0ffbcc3d191bcc63b5efb852ca3fd3f3d6b4cf64fee5ee745cb7
MD5 0ffd04fed69e72f4d3999a00ad1681f4
BLAKE2b-256 e854b1e218246dfbc8e6642c538ad35c14ac2b2c293c252a5bdbeeda9b599095

See more details on using hashes here.

Provenance

The following attestation bundles were made for zompi-0.1.1.tar.gz:

Publisher: python-publish.yml on utiteam-python/zompi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file zompi-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: zompi-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 5.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for zompi-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 542cd35d31c3f13d0e33eca32156840ec8323f16360b360811e55db7d86a6650
MD5 7257ddc07c021b8043836ff5299ea818
BLAKE2b-256 27ab092e5aa64c06aaa04cabefa833aed7c5c086bf842ebf5afcab649bfed30e

See more details on using hashes here.

Provenance

The following attestation bundles were made for zompi-0.1.1-py3-none-any.whl:

Publisher: python-publish.yml on utiteam-python/zompi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page