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

Configureable needs.json builder #1169

Open
danwos opened this issue Apr 25, 2024 · 0 comments
Open

Configureable needs.json builder #1169

danwos opened this issue Apr 25, 2024 · 0 comments

Comments

@danwos
Copy link
Member

danwos commented Apr 25, 2024

To allow users to define the content of a needs.json file and to keep multiple of these configurations available without making changes in the conf.py file, dynamic needs.json builders shall be registerable.

Example conf.py:

needs_builders = {
  "my_needs": {
    "contains": [...]
    "excludes": [...]
    "filename": "my_own_needs.json"
  }
  "my_builder_2":  {...}
}

The different builders shall be available by their key.
Example: sphinx-build -b my_needs . _build/ or make my_needs.

contains defines a list of values, which shall be part of the file. All not-mentioned values are not taken into account.

excludes takes everything into account, also all internal values. But removes the defined values.

filename is the name of the file under which the data gets stored. needs.json is not allowed, as a needs.json shall follow a certain standard.

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

No branches or pull requests

1 participant