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

feat: automatically generate docspec for Python projects #10

Merged
merged 10 commits into from
Aug 28, 2024

Conversation

barjin
Copy link

@barjin barjin commented Aug 28, 2024

With

{
  python: true,
  projectRoot: 'path/to/python/project',
  packages: ['.']
}

the plugin now uses pydoc-markdown to parse the Python projects and generate Python documentation.

In case Python or pydoc-markdown is missing, the script prints a comprehensible warning message and fails.

@barjin barjin self-assigned this Aug 28, 2024
@barjin barjin force-pushed the feat/python-docs-autogen branch from 0ae6b1f to 99e177e Compare August 28, 2024 12:12
@barjin barjin merged commit 4cd9ea9 into master Aug 28, 2024
4 checks passed
@barjin barjin deleted the feat/python-docs-autogen branch August 28, 2024 13:58
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.

1 participant