:meta private: tag does not work

ammaraskar / sphinx-action

Github action that builds docs using sphinx and places errors inline

Apache License 2.0

195 stars 117 forks source link

:meta private: tag does not work #22

Closed cysabi closed 3 years ago

cysabi commented 3 years ago

Some of my docstrings include the :meta private: attribute.

When I build the html files from source, the proper methods are hidden.

However, when using the action, the attribute is not used and even shows up in the documentation:

ammaraskar commented 3 years ago

Hey Lepto, it looks like :meta private: was introduced in Sphinx 3.0+ which is why this doesn't work right now. I'm looking into allowing users to customize their sphinx version in https://github.com/ammaraskar/sphinx-action/issues/25, so I'm gonna close this as a duplicate of that.