enthought / enthought/codetools

Fix documentation build for Python 3

Aperta
#32 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Python
Stelle
54
Fork
10
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

The documentation doesn't currently build under Python 3. The immediate error is due to use of execfile in the Sphinx configuration, but there may be others.

mirzakhani:docs mdickinson$ make html
sphinx-build -b html -d build/doctrees   source build/html
Running Sphinx v1.8.3

Configuration error:
There is a programmable error in your configuration file:

Traceback (most recent call last):
  File "/opt/local/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/sphinx/config.py", line 368, in eval_config_file
    execfile_(filename, namespace)
  File "/opt/local/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/sphinx/util/pycompat.py", line 150, in execfile_
    exec_(code, _globals)
  File "/Users/mdickinson/Enthought/ETS/codetools/docs/source/conf.py", line 44, in <module>
    execfile(os.path.join('..', '..', 'codetools', '__init__.py'), d)
NameError: name 'execfile' is not defined

make: *** [html] Error 2

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia da docs/source/conf.py, in particolare dalla chiamata a execfile mostrata nel traceback, ed esegui make html con Python 3 per identificare eventuali ulteriori errori di configurazione. Il lavoro è completato quando la build della documentazione termina correttamente con Python 3.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
build-system, documentation
Tipo di issue
Bug
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
55/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.