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

autogenerate items in site/reference.md from python code #119

Open
4 tasks
ericbuckley opened this issue Nov 4, 2024 · 0 comments
Open
4 tasks

autogenerate items in site/reference.md from python code #119

ericbuckley opened this issue Nov 4, 2024 · 0 comments
Labels
automation Automation of processes documentation Improvements or additions to documentation

Comments

@ericbuckley
Copy link
Collaborator

ericbuckley commented Nov 4, 2024

Summary

Update doc build process to dynamically generate values on the reference page from source code.

Acceptance Criteria

  • A module to support autogenerating features and their descriptions (from docstrings)
  • A module to support autogenerating blocking keys and their descriptions (from docstrings)
  • A module to support autogenerating matching functions and their descriptions (from docstrings)
  • Update to the build docs process to add results from the above modules into the markdown

Dependencies

#112

@ericbuckley ericbuckley self-assigned this Nov 4, 2024
@ericbuckley ericbuckley added documentation Improvements or additions to documentation automation Automation of processes labels Nov 4, 2024
@ericbuckley ericbuckley removed their assignment Dec 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automation Automation of processes documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant