API docs generator... #305
Draft
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.
Summary of changes
This is a proposal for a new API generator using
mkdocstrings(see issue #65).The new script should be less prone to bugs because it involves a transition from MD to MDX—which are very similar—rather than converting from RST to MDX.
This is just an initial version, so please let me know what you think of the new format! It is very easy to adjust, so if you have any specific requests, I can easily implement them.
PS: I added a
pyproject.tomlto the project to streamline development. This might cause some conflicts withMint, but I’ve added a.mintignorefile to prevent any issues.