Update API docs to include Pathfinder

[aphc14]

The Pathfinder module has undergone significant changes in the pymc-extras 0.2.2 release #418 and seems to be functioning properly. As such, we need to update the Pathfinder API docs to include fit_pathfinder and document:

• Parameter settings and options
• Basic guidelines for setting the parameters

[muhammadalmaskhan]

Hi, I'd love to contribute by updating the Pathfinder API documentation! Could you provide any specific formatting or style preferences for the docs? I'll begin drafting the updates and submit a PR soon

[aphc14]

Hi @muhammadalmaskhan, thanks for offering to contribute. Here are some useful resources to get started:

• Build documentation locally
• Numpydoc style guide
• API file

The most appropriate place to include fit_pathfinder in the API docs would probably be after fit but before Chi.

I'm pretty sure the docstrings in fit_pathfinder follow the numpydoc style guide. If the makefile doesn't auto-generate the docstrings, it might need editing to meet the style requirements.

[aphc14]

Hi @muhammadalmaskhan, how are you going with this? The API documentation for fit_pathfinder should be released to users soon because it is a new feature that not too many users are familiar with. Would you mind if I proceeded with this?