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

needs.json builder performance #957

Closed
danwos opened this issue Aug 3, 2023 · 1 comment · Fixed by #1054
Closed

needs.json builder performance #957

danwos opened this issue Aug 3, 2023 · 1 comment · Fixed by #1054
Assignees

Comments

@danwos
Copy link
Member

danwos commented Aug 3, 2023

Some actions are happening also in the needs.json-builder, which are not needed for the json-output itself.

For instance in the function process_need_nodes the print_need_nodes()-func gets executed which prepares the docutil-table representation of a need.

print_need_nodes(app, doctree, fromdocname, found_needs_nodes)

There may be other locations and actions, which calculate some unneeded stuff. Some ideas:

  • Representation of needtable
  • Representation of needflow and needuml
  • Copying css/js data to _static (may be already deactivated)

We need a way to skip such actions if a builder is used, which is not transforming the doctree into a result-format.

A simple if builder == "needs" is not working, as it does not allow to integrated other builders in future.
For instance, a PR is getting prepared, which creates a needs.json per file or even per need-object.
So checking the builder-type may be a better approach, not sure....

@danwos
Copy link
Member Author

danwos commented Aug 24, 2023

Also smartquotes handling should be deactivated by default, as our jsin-files only contain the unrendered rst-code.

chrisjsewell added a commit that referenced this issue Oct 28, 2023
Remove additional keys from the needs.json, that are not intended to be exposed to the user.

(Note, this is relevant for #957)
chrisjsewell added a commit that referenced this issue Oct 28, 2023
Remove additional keys from the needs.json, that are not intended to be exposed to the user.

(Note, this is relevant for #957)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants