search

sphinx-contrib / napoleon

Other
148 stars 48 forks source link

Documentation: Adds user defined custom sections #5

Closed sobolevn closed 6 years ago

sobolevn commented 6 years ago

Hi, thanks for this tool and the recent update.

I am wondering what does the following mean: "Adds user defined custom sections". I am highly interested in this feature, but I am unable to find any documentation about how that should work.

Could you please guide me, so I can write the proper docs for this feature? Or maybe I am just missing something.

RobRuana commented 6 years ago

Apologies, the docs were not automatically updated with the newest release. There is a small section describing the napoleon_custom_sections here:

https://sphinxcontrib-napoleon.readthedocs.io/en/latest/sphinxcontrib.napoleon.html#sphinxcontrib.napoleon.Config.napoleon_custom_sections

You add that setting in your conf.py.