Articles of python sphinx

¿Es práctico poner Python bajo control de versión?

Donde sea práctico, me gusta tener las herramientas necesarias para una compilation bajo control de versión. Lo ideal es que se ejecute un nuevo process de pago en cualquier máquina con un set mínimo de herramientas que se requieren para ser instaladas primero. ¿Es práctico tener Python bajo control de versión? ¿Qué hay de los […]

readthedocs build que falla pero local sphinx build funcionando

Recibo el siguiente error en readthedocs cuando bash crear documentos manualmente o cuando se genera una compilation presionando al repository de GitHub: python2.7 -mvirtualenv –no-site-packages –no-download /home/docs/checkouts/readthedocs.org/user_builds/my_project_name/envs/latest New python executable in /home/docs/checkouts/readthedocs.org/user_builds/my_project_name/envs/latest/bin/python2.7 Traceback (most recent call last): File "/usr/lib/python2.7/runpy.py", line 162, in _run_module_as_main "__main__", fname, loader, pkg_name) File "/usr/lib/python2.7/runpy.py", line 72, in _run_code exec code […]

Agregue un button "Editar en Bitbucket" en la documentation de Sphinx para los files fuente como el button en el tema readthedocs

Estoy desarrollando mi documentation para un proyecto usando Sphinx y Readthedocs. Quiero agregar un button como el que está en la parte superior del tema de Readthedocs "Editar en Bitbucket". Pero en lugar de editar el file de documentation, me gustaría señalar un file fuente en el repository. Actualmente estoy usando algo como esto para […]

Texto reestructurado: retrocede si falta el module doctest

Parece que Github no admite la syntax sphinx.ext.doctest en su procesador reStructunetworkingText, que está causando algunos problemas al intentar include un bloque de código de estilo .. doctest ( .. doctest ) en un README.rst que se transcribe a la documentation índice (que es renderizado por sphinx). Si reemploop la directiva .. doctest con otra […]

Python-sphinx: ignorar el text en el primer file

Tengo un README.rst en GitHub que también está incorporado en la documentation generada por Sphinx para un proyecto de Python. Me gustaría include una nota en la parte superior del file que se mostrará en GitHub (que simplemente representa el .rst) pero no se muestra en los documentos generados por Sphinx. Sé que puedo include […]

Enlaces de GitHub en documentos de Sphinx

Aquí hay un ejemplo del documento de Sphinx: https://github.com/django-tastypie/django-tastypie/blob/v0.13.2/docs/release_notes/v0.13.2.rst Me gustaría comprometer SHA's, numbers de edición y @mentions a hyperlink. De todos modos para hacer eso automáticamente?

readthedocs no crea documentation del repository público de github

Tengo un repository público de github. Siguiendo las instrucciones en readthedocs, utilicé Sphinx para get la documentation en una forma que estoy feliz de que otros vean. Edite sus files y recupérelos hasta que le guste lo que ve, luego envíe sus cambios y envíelos a su depósito público. Una vez que tenga la documentation […]

¿Cómo configurar múltiples documentos de Sphinx en un proyecto en ReadTheDocs?

Me gustaría utilizar ReadTheDocs para alojar mi documentation de Sphinx. El proyecto está alojado en github. Puedo conectarme a él bien. La particularidad que tengo es que el proyecto contiene 2 documentos de Sphinx (por ejemplo, un manual del progtwigdor y un manual del usuario). ReadTheDocs parece detectar ambos (hay dos conf.py) y generar ambos. […]

La directiva autodoc funciona localmente pero no en readthedocs

Mi informe se encuentra en github aquí: https://github.com/AshleySetter/optoanalysis Y los documentos están en https://github.com/AshleySetter/optoanalysis/tree/master/optoanalysis/docs ReadTheDocs no falla, pero la documentation producida (alojada aquí: https://optoanalysis.readthedocs.io/en/latest/ ) no muestra las cadenas de documentos que debe producir el command ..autodoc:: . Sin embargo funciona perfectamente localmente y muestra la documentation cuando abro el file build / html / […]

use el mismo contenido de README en sphinx y github – enlaces relativos

Estoy agregando una página de Leer los documentos para mi proyecto. Por ahora, quiero el mismo contenido en mi página de Read The Docs que en mi file README. Mi file docs/index.rst ve así: .. include:: ../README.rst .. toctree:: :maxdepth: 2 :caption: Contents: Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` Esto funciona […]