Add Python API documentation / Module reference to the documentation/website about dynaconf HOT 3 CLOSED

Hello, I'd be interested in picking this one up as a first issue.

I've been thinking about the approach and I have setup a little demo repo where I have created a dummy API and have then followed the automatic code reference pages recipe in the mkdocstrings docs. You can check out the results in the pages site linked in the README file.

I'm sure there might be some discussion to be had on what's included automatically, whether you might want to exclude things to avoid clutter. I'm guessing some amendments to this script would be needed for that but it would require a little experiment once I have an idea what you want.

What is displayed and what isn't can be tightly controlled by following the Usage section of mkdocstrings docs although this won't be automated so will create a little more burden on development and potential for gaps. It could however be used to try and model the look and feel that is wanted from the auto-generated API.

Just a couple of other clarifying points:

• What name would you want to give the top level of the Nav? "API Reference" or "API"?
• Would you want it at the bottom of the existing Nav headers?

Look forward to hearing your thoughts.

from dynaconf.

I guess the documentation should appear on the left menu as Reference > API https://www.dynaconf.com/api

from dynaconf.

Other good candidates for a reference sections are:

• dynaconf module API (Validator, inspect_settings, get_history, and others explicitly exposed utilities)
• The actual CLI page, which contains mostly the CLI API description. There are some usage examples, but mkdocstrings allows interleaving manual entries with generated entries via some custom markup.
• The actual Configuration page (but it would require some code changes, so the plugin can parse descriptions and types. Could be tricky).

from dynaconf.