CODEWITHSUNDEEP
pythonpython-sphinxdocumentation-generation
orome
orome

Reputation: 48466

How do I omit the values of variables on Sphinx?

I have some module-level variables that have long and uninteresting values which I would like to exclude from auto-generated documentation. Is there a way to do this?

For example, in my Python source I have something like

#:This is a variable with a log value.
long_variable = "Some really long value that is not really of interest and just kind of gets in the way of reading and understanding what's going on."

and in my Sphinx source I have 

.. automodule:: the_module
   :members:

and I want the documentation to omit the variable value.

How do I omit the value of variables on Sphinx? Is there ay way to do this in the Python source for specific variables; can I do it in the Sphinx source either for the whole module or for individual variables?

Upvotes: 6

Views: 2743

Answers (2)

JuanPi
JuanPi

Reputation: 781

To hide the contents of a variable use the meta info list field https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#info-field-lists.

An example can be found here https://stackoverflow.com/a/67999830/487993

Upvotes: 2

mzjn
mzjn

Reputation: 50947

Two solutions I can think of:

Upvotes: 1

Related Questions