draft: generate reference documentation using mkdosctrings#89
Draft
easytypewriter wants to merge 1 commit intowiremock:masterfrom
Draft
draft: generate reference documentation using mkdosctrings#89easytypewriter wants to merge 1 commit intowiremock:masterfrom
easytypewriter wants to merge 1 commit intowiremock:masterfrom
Conversation
Member
|
Sorry, I missed that PR. Added to my list |
Member
|
It is a good start anyway. Worst case we could attach code docs as a generated HTML |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This draft PR shows my work so far on automatically generating a reference section of the documentation based on docstrings in the source code.
I find that
mkdosctringsmay not be a sufficient tool for this task because it seems more optimized towards documenting individual functions or modules, rather than a full library. I will continue to research and try to understand how projects like interactions.py and Serenity generate their documentation.Note: I adjusted the available Python versions for compatibility with the new documentation dependencies. I understand this may pose an issue.
References
Submitter checklist