8000 Feature request: Support sphinx/autodoc documentation or read python docstrings · Issue #35 · upstash/context7 · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Feature request: Support sphinx/autodoc documentation or read python docstrings #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
fzimmermann89 opened this issue Apr 18, 2025 · 2 comments
Open

Feature request: Support sphinx/autodoc documentation or read python docstrings #35

fzimmermann89 opened this issue Apr 18, 2025 · 2 comments
Labels
docs parsing

Comments

@fzimmermann89
Copy link

Hi,
lots of python packages generate a substantial part of their api documentation from docstrings inside the code using sphinx/autodoc.
It would be great if one could either point to the generated documentation or, or if the indexer would try to index docstrings.
@enesakar
Copy link
Contributor

yes, this is also requested for asciidoc. we need to work on those.

@enesakar enesakar transferred this issue from upstash/context7-legacy Apr 21, 2025
@cmbant
Copy link
cmbant commented Apr 21, 2025

Meanwhile, should probably add option to remove/cancel docs after adding, snippets that all look like this are not helpful

----------------------------------------

TITLE: Generating Documentation for getdist.gaussian_mixtures Module in Python
DESCRIPTION: This code snippet uses Sphinx's automodule directive to automatically generate documentation for all members of the getdist.gaussian_mixtures module. This includes classes, functions, and other objects defined in the module.
SOURCE: https://github.com/cmbant/getdist/blob/master/docs/source/gaussian_mixtures.rst#2025-04-21_snippet_0

LANGUAGE: restructuredtext
CODE:

.. automodule:: getdist.gaussian_mixtures
:members:


----------------------------------------

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs parsing
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@enesakar @cmbant @fzimmermann89 @enesgules
0