suny-downstate-medical-center / netpyne

A Python package to facilitate the development, parallel simulation, optimization and analysis of multiscale biological neuronal networks in NEURON.
http://www.netpyne.org
MIT License
145 stars 136 forks source link

Conceal 'private' methods from documentation #816

Open salvadord opened 5 months ago

salvadord commented 5 months ago

Now "package reference" section lists all the methods/functions across the codebase. But many of them are intended to be private. I suppose sphinx (lib that autogenerates the docs) should have such option to exclude a given method, otherwise, we can try prefixing the private ones with double-underscore. The ultimate goal is to make only those methods to be discoverable through docs, which are intended to be exposed to the users