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

Configurable python path per package #77

Open
4 tasks done
silvester747 opened this issue Mar 5, 2023 · 1 comment
Open
4 tasks done

Configurable python path per package #77

silvester747 opened this issue Mar 5, 2023 · 1 comment
Assignees
Labels
Milestone

Comments

@silvester747
Copy link
Collaborator

silvester747 commented Mar 5, 2023

Support configuring a path containing python scripts to be included in the documentation. The path will be added to the python path in the documents before rendering.

Allow specifying a python path per package and on the command-line

  • Extend package definition with python path
  • Extend command line options with default python path
  • Extend renderer to include python paths in templates
  • Extend documentation
@silvester747
Copy link
Collaborator Author

The imports argument in the constructor of Template can be used to add arbitrary python code at the start of the generated template code. Due to the use of caching, we need to also set this in the TemplateLookup instances. As we only have a single instance of TemplateLookup for documents, start with always inserting the python path for all packages. If the need arises, we can always improve.

@silvester747 silvester747 self-assigned this Mar 5, 2023
@silvester747 silvester747 added Improvement New feature or request Feature labels Mar 5, 2023
@silvester747 silvester747 added this to the 0.8.x - Bombe milestone Mar 5, 2023
@silvester747 silvester747 removed the Improvement New feature or request label Mar 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant