[Discussion] Docs rewrite
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Documentación
- Claridad
- Necesita aclaración
- Estado de actividad
- Tranquilo
- Stack tecnológico
- python
- Área
- documentation
Línea de trabajo
Review the documentation on the gh-pages branch, the existing Markdown files, and the relevant .py files containing type hints and docstrings. Read the proposed Sphinx autodoc approach and assess how the documentation could be represented in reStructuredText while preserving publication to gh-pages. The issue does not define a specific migration scope or completion criteria.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Currently, documentation is maintained on a separate branch, gh-pages, and written in Markdown. With all of the type hints that have been incorporated over the last few releases, IDE/LSP's will have better information about what function signatures are available and being used. Python's default way of making documentation available to users is through docstrings.
What I propose is that instead of separately maintaining the documentation, especially the user facing TSC API documentation, separately, that it be maintained through docstrings in the .py files. Then the markdown that is currently being used is converted to reStructuredText. This would open up the ability to use sphinx and its autodoc extension to read those docstrings and produce the web navigable documentation. I believe the docs could still be published to gh-pages, so URLs would not have to change.
.rst is definitely not as simple of a format as .md, but the ability to fetch docstrings and function signatures I think offers a clear advantage over continuing with markdown.
- Lenguaje dominante
- Python
- Estrellas
- 716
- Forks
- 446
- Merge medio
- 8 d 8 h
- PR fusionados (30 d)
- 2
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de tableau/server-client-python
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
tableau/server-client-python#1865 ·
-
in-progress
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
tableau/server-client-python#1829 · 1 comentario ·
-
enhancement gap needs investigation
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
tableau/server-client-python#1322 · 1 comentario ·
-
[Type2] Allow Incremental Refresh type schedules to be added via `server.schedules.add_to_schedule` Abiertohelp wanted Server-Side Enhancement ui-exists
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
tableau/server-client-python#1101 · 3 comentarios ·
-
enhancement good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
tableau/server-client-python#783 · 5 comentarios ·
Todos los issues de tableau/server-client-python
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
anthropics/skills#1811 · 1 comentario ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
speaches-ai/speaches#678 ·
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
datalayer/mcp-compose#42 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
conda-forge/spacy-feedstock#177 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
UKGovernmentBEIS/inspect_evals#2523 ·