Discussion:
[domain:cpp] is it currently possible to document a struct?
(too old to reply)
Stephen McDowell
2018-02-16 23:39:48 UTC
Permalink
The .. cpp:class:: directive (http://www.sphinx-doc.org/en/stable/domains.html#directive-cpp:class <http://www.sphinx-doc.org/en/stable/domains.html#directive-cpp:class>) will always produce class in the signature. I’ve been staring at the code for a while, but I can’t figure out how to get `struct` to appear in the documentation instead of `class`. This line seemed relevant:

https://github.com/sphinx-doc/sphinx/blob/e505cbb3be083b5c6786862d0ad94ef6e62733e0/sphinx/domains/cpp.py#L152 <https://github.com/sphinx-doc/sphinx/blob/e505cbb3be083b5c6786862d0ad94ef6e62733e0/sphinx/domains/cpp.py#L152>

But I think that only applies to template parameters?

Thanks for any suggestions!

-Stephen
--
You received this message because you are subscribed to the Google Groups "sphinx-dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-dev+***@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
Loading...