python-sphinx

8calore

2risposta

Controllo delle versioni coerente nel progetto Python

Ho un progetto Python con documentazione e distutils di Sphinx per la pubblicazione su Pip. Entrambe queste funzioni richiedono una versione (per esempio, 0.4b3) C'è una best practice per mantenere au

python version project distutils python-sphinx 2012-02-16

---

13calore

3risposta

Aggiunta di un tag script javascript in qualche posto in modo che funzioni per ogni file nella documentazione della sfinge

Sto usando Sphinx per scrivere delle note. Sto usando l'estensione Mathjax per Math nelle note. La dimensione predefinita della matematica è poco più grande di quanto vorrei. Sulla pagina Mathjax ho s

javascript python python-sphinx 2012-02-25

---

8calore

1risposta

Python-Sfinge: collegamento alla sezione nel file esterno

Voglio collegarmi a una sezione in un file esterno, ma non riesco a farlo funzionare. Il :ref: non sembra funzionare globalmente, o lo uso male? .. File: some_file.rst .. _ref_section: Some S

python-sphinx cross-reference 2012-01-09

---

14calore

2risposta

Come documentare i parametri della funzione Python con sphinx-apidoc

Sto cercando di pulire la mia documentazione del codice Python e ho deciso di usare sphinx-doc perché sembra buono. Mi piace come posso fare riferimento altre classi e metodi con tag come: :class:`mym

python python-sphinx documentation-generation api-doc 2012-03-02

---

6calore

2risposta

Utilizzo di spodx autodoc per un file favoloso

È possibile utilizzare Spodx autodoc per generare documentazione per il mio file, dalla docstring della funzione? E.g. per un fabfile contenente un compito setup_development ho provato: .. automodule:

python python-sphinx fabric autodoc 2012-01-13

---

15calore

2risposta

Quali file devo dire al mio VCS di ignorare quando si utilizza Sphinx per la documentazione?

Voglio iniziare a utilizzare Sphinx per documentare il mio progetto. Ho detto a Sphinx di usare fonti separate e creare directory durante lo sphinx-quickstart. Ora il mio layout della directory è la s

python git version-control documentation python-sphinx 2012-03-05

---

5calore

1risposta

Come cambio la directory di output `_target` per HTML Builder nella sfinge?

Sto provando a usare Sphinx per compilare docuemntation per inviare a github pages. Sto usando il builder html predefinito per generare la documentazione della guida e inserirla in un ramo gh-pages (v

python-sphinx github-pages 2012-01-16

---

9calore

1risposta

Visualizza le docstrings di ReStructuredText (Sphinx) in iPython?

C'è un modo per avere IPython rendere pienamente reStructuredText (per Sphinx) docstrings quando si digita il seguente: help foo o: foo? Trovo eccellente distrazione per provare a leggere aiuta i

python ipython python-sphinx restructuredtext docstring 2012-01-24

---

10calore

5risposta

valori Sphinx per gli attributi riportati come Nessuno

Quando uso Sfinge autodoc per documentare una classe, i valori per gli attributi vengono sempre segnalati, (come si dice dovrebbe here, sotto # 437), ma sempre come "= None" Attribute = None Some

python python-sphinx 2012-02-05

---

14calore

2risposta

definire markup per ammonizioni generiche di sfinge con un titolo specifico

Sto usando Sphinx per generare documentazione HTML per un programma Python. Vorrei utilizzare la direttiva generica admonition (cfr http://docutils.sourceforge.net/docs/ref/rst/directives.html#generic

markup python-sphinx restructuredtext 2012-02-06

---