Hi,
There is no such feature. You need to write a code to extract data from Sphinx.
This is an example code to get the list of C objects. Please append
this into your conf.py.
```
def on_env_check_consistency(app, env):
domain = env.get_domain('c')
for c_object in domain.get_objects():
print(c_object)
def setup(app):
app.connect('env-check-consistency', on_env_check_consistency)
```
Note: This hooks "env-check-consistency" event and get C objects from C domain.
For more details, please read developers reference:
* https://www.sphinx-doc.org/en/master/extdev/index.html
* https://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx-core-events
*
https://www.sphinx-doc.org/en/master/extdev/domainapi.html#sphinx.domains.Domain.get_objects
Thanks,
Takeshi KOMIYA
2020年9月12日(土) 0:16 Matias v01d <[email protected]>:
>
> Hi,
> we're using Sphinx to document a C interface. I would like to get a list of
> all documented functions, structs, types, etc, generated and output
> to a file in YAML/JSON or similar in order to use this to automatically check
> API stability by comparing to previous releases.
> Is this possible somehow?
>
> Thanks,
> Matias
>
> --
> You received this message because you are subscribed to the Google Groups
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to [email protected].
> To view this discussion on the web visit
> https://groups.google.com/d/msgid/sphinx-users/62f3be60-dc02-4325-a33c-0ec973f0c104o%40googlegroups.com.
--
You received this message because you are subscribed to the Google Groups
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/sphinx-users/CAFmkQAOf%3D%3DWtDfZRd7OC%3DUgNeXw_%3DZ%3DbjETW-9k%2BNXO8yFpVrg%40mail.gmail.com.
