es.davy.ai

Preguntas y respuestas de programación confiables

¿Tienes una pregunta?

Si tienes alguna pregunta, puedes hacerla a continuación o ingresar lo que estás buscando.

Tag: PYTHON-SPHINX

Sphinx no puede encontrar mis funciones (probablemente debido a los importes o la estructura de carpetas).

Tengo la siguiente estructura de carpetas para un proyecto de paquete (simplificado): projectname ├── docs ├── packagename │ ├── somemodule │ │ ├── init.py (segundo) │ │ └── somescript.py │ └── init.py (primero) ├── setup.cfg └── pyproject.toml En el primer archivo init.py hago “from . import somemodule”. En el segundo . . . Read more

Obteniendo el error de “Extensión (sphinx.environment.collectors.toctree)” al agregar nodos de sección en la extensión de Sphinx.

Estoy intentando escribir una nueva extensión de Sphinx. Un ejemplo mínimo de una extensión que hace algo similar a lo que quiero es: from docutils import nodes from docutils.parsers.rst import Directive class HelloSection(Directive): def run(self): section_dir = nodes.section() section_dir += nodes.title(text=”Un ejemplo”) section_dir += nodes.paragraph(text=”Hola, mundo”) return [section_dir] def setup(app): . . . Read more

Sphinx Autodoc sin submódulos

Estoy desarrollando un paquete de Python que permite a los usuarios importar sus funciones de esta manera: import mymodule mymodule.afunction() Estoy documentando el código con Sphinx. Primero ejecuté sphinx-quickstart, luego cambié conf.py para incluir sys.path.insert(0, os.path.abspath(‘../../src/mymodule’)). Luego ejecuté sphinx-apidoc -f -o source ../src/mymodule y make html. La estructura del directorio . . . Read more

La página de GitLab para el proyecto Sphinx no está funcionando como se espera.

El enlace al proyecto completo es https://gitlab.com/ComplicatedPhenomenon/doubancrawler Probé el documento generado en la máquina local y funciona bien y la página de GitLab es la siguiente (https://complicatedphenomenon.gitlab.io/doubancrawler/api.html) ¿Hay algo mal con .gitlab-ci.yml? image: python:3.7-alpine test: stage: test script: – pip install -r requirements2.txt – cd docs/source/ – sphinx-build -b html . . . Read more