[Doc PR Part 3] Add scripts to automatically generate API reference md files #1980
+462
−14
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We add two scripts:
generate_api_docs.py
: Generate an .md file for each public class/function.generate_api_summary.py
: Generate the index inmkdocs.yml
to refer to the doc page for each public class/function.At doc deployment time, these 2 scripts should be executed to generate the latest documentation.
Some notes:
dspy.ChainOfThought
,dspy.predict.ChainOfThought
,dspy.predict.chain_of_thought.ChainOfThought
all point to the same thing. We only generate doc for the top leveldspy.ChainOfThought
, which is our recommended path__all__
attribute in__init__.py
files. Or say we only generate API reference for classes/functions we would like to have users interact with.