Sphinx documentation: No backlink to the main project

Abierto Apto para principiantes
#258 0 comentarios 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
68/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
python
Área
documentation

Línea de trabajo

Inspecciona la configuración de la documentación de Sphinx para los bindings de Python, especialmente la configuración de la barra lateral, y revisa el diseño de la página generada. El trabajo estará terminado cuando la documentación incluya un enlace de retorno a https://precice.org/couple-your-code-api.html y el enlace sea visible en la barra lateral o en una navegación equivalente.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

documentation

In the Sphinx documentation, there is no backlink to the preCICE website. That would be useful for people landing directly to the Python bindings documentation from a search engine, for example.

I think that adding something in the sidebar, for example, would be good. It could link to https://precice.org/couple-your-code-api.html

Current view:

Image

Diverged from #239

Lenguaje dominante
Cython
Estrellas
30
Forks
19
Sin PR fusionados en 30 d

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de precice/python-bindings

Todos los issues de precice/python-bindings

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.