Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

draft: generate reference documentation using mkdosctrings #89

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

erikkristoferanderson
Copy link
Contributor

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 mkdosctrings may 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

  • The PR request is well described and justified, including the body and the references
  • [?] The PR title represents the desired changelog entry
  • [-] The repository's code style is followed (see the contributing guide)
  • [-] Test coverage that demonstrates that the change works as expected
  • [-] For new features, there's necessary documentation in this pull request or in a subsequent PR to wiremock.org

@oleg-nenashev
Copy link
Member

Sorry, I missed that PR. Added to my list

@oleg-nenashev
Copy link
Member

It is a good start anyway. Worst case we could attach code docs as a generated HTML

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants