2010-04-05 15 views
26

En muchos proyectos django, en el directorio de documentos puedo ver los archivos * .rst:Cómo navegar (sin editor de texto) .rst archivos?

¿Cuál es la mejor manera de navegar por ellos (sin usar un editor de texto, por supuesto)?

¿Es posible generar HTML?

+1

¿Puedes editar la descripción para expandir "sin usar un editor de texto por supuesto"? Eso parece ser una buena manera, y sus razones para rechazarlo no están claras. – bignose

Respuesta

25

.rst archivos son ReStructuredText formato. Parecen archivos de texto, pero se pueden representar en HTML con el paquete Python docutils.

1

This page describe cómo crear la propia documentación de Django en HTML, a través de la biblioteca Sphinx. Otros proyectos probablemente funcionen de la misma manera.

+0

https://docs.djangoproject.com/en/1.8/internals/contributing/writing-documentation/ –

5

Trate restview

+10

Si bien esto puede responder teóricamente a la pregunta, [sería preferible] (http://meta.stackexchange.com/q/8259) para incluir las partes esenciales de la respuesta aquí y proporcionar el enlace de referencia. –

11

Como Zjk dice, puede utilizar Restview:

Restview está disponible en el índice de paquetes Python: http://pypi.python.org/pypi/restview. También puedes instalar installview.

Aquí es lo que hice para poner a prueba a cabo utilizando un entorno virtual:

mkdir restview 
cd restview/ 
virtualenv-2.7 venv # The second system I used just used 'virtualenv venv' 
./venv/bin/pip install restview 
./venv/bin/restview ~/path/MANUAL.rst 

Esto puso en marcha un servidor web y abrió la página de documentación en mi navegador.

Nota: Solo uso virtualenv porque no me gusta instalar cosas de forma global. Puede ser exagerado para muchos otros, pero también tengo mejor suerte con estos entornos únicos. Cuando probé pip install restview en una máquina virtual Ubuntu 14.04 falló, mientras que el enfoque anterior funcionó como un encanto para mí en ese sistema, así como este.

-3

simplemente cambie el nombre de la extensión de archivo a .txt y luego abra el archivo con cualquier texto.

Las personas tienden a establecer las fronteras y los obstáculos para ocultar su conocimiento: un intervalo de tiempo.

Cuestiones relacionadas